Casts a vote for the active NPS survey in the specified company context.

post

https://example.com/wep/companies/{companyId}/nps/{surveyId}

Access: System, Admin, ClientAdmin, and Employee users with access to the company.

The rating is required and the comment is optional. The response contains the survey vote result returned by the NPS service.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

int32

required

Optional company identifier from the route.

surveyId

int32

required

NPS survey identifier.

Body Params

Vote values to submit.

Request payload used to submit an NPS vote.

rating

int32

required

0 to 10

Rating to submit for the survey. Allowed values are 0 through 10. Required.

comment

string | null

Optional free-text comment that accompanies the submitted rating.

Headers

api-version

string

required

Defaults to 2.0

The requested API version

x-api-version

string

Defaults to 2.0

The requested API version

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Credentials

Bearer

jwt

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

text/plain

200OK