Pular para o conteúdo

POST /v1/csat

POST
/v1/csat
curl --request POST \
--url https://seu-endereco-da-api/v1/csat \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "deliveryMode": "interactive", "questionText": "example", "options": [ { "value": 1, "label": "example", "sentiment": "bad" } ], "templateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "active": true, "validateResponse": true, "maxAttempts": 1, "errorMessage": "example", "feedbackMessage": "example", "templateVariables": [ "example" ], "headerMediaKey": "example", "headerMediaMime": "example" }'

Permissão que a Chave de acesso precisa: Gerenciar pesquisa de satisfação (csat:manage).

Media typeapplication/json
object
name
required
string
>= 1 characters
deliveryMode
required
string
Allowed values: interactive text template
questionText
required
string
>= 1 characters
options
Array<object>
<= 10 items
object
value
required
number
label
required
string
>= 1 characters
sentiment
string
Allowed values: bad neutral good
templateId
string format: uuid
active
boolean
validateResponse
boolean
maxAttempts
number
>= 1 <= 10
errorMessage
string
feedbackMessage
string
templateVariables
Array<string>
headerMediaKey
string
headerMediaMime
string
Media typeapplication/json
object
id
required
string
name
required
string
deliveryMode
required
string
questionText
required
string
options
required
Array<object>
object
value
required
number
label
required
string
sentiment
required
string
Allowed values: bad neutral good
templateId
required
string
nullable
active
required
boolean
validateResponse
required
boolean
maxAttempts
required
number
errorMessage
required
string
nullable
feedbackMessage
required
string
nullable
templateVariables
required
Array<string>
nullable
headerMediaKey
required
string
nullable
headerMediaMime
required
string
nullable
headerMediaUrl

Temporary link to the header media; on the list and single reads

string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time

Example

{
"options": [
{
"sentiment": "bad"
}
]
}

Csat survey name already in use