Pular para o conteúdo

PATCH /v1/closing-reasons/{id}

PATCH
/v1/closing-reasons/{id}
curl --request PATCH \
--url https://seu-endereco-da-api/v1/closing-reasons/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "active": true, "sortOrder": 1, "csatSurveyId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "sequenceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "farewellMessage": "example" }'

Permissão que a Chave de acesso precisa: Gerenciar motivos de fechamento (closing-reasons:manage).

id
required
string
Media typeapplication/json
object
name
string
>= 1 characters
active
boolean
sortOrder
number
csatSurveyId
string format: uuid
sequenceId
string format: uuid
nullable
farewellMessage
string
<= 1024 characters

Example generated

{
"name": "example",
"active": true,
"sortOrder": 1,
"csatSurveyId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"sequenceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"farewellMessage": "example"
}
Media typeapplication/json
object
id
required
string
name
required
string
active
required
boolean
sortOrder
required
number
csatSurveyId
required
string
nullable
sequenceId
required

Sequence the contact enters when a conversation is closed with this reason

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

Example generated

{
"id": "example",
"name": "example",
"active": true,
"sortOrder": 1,
"csatSurveyId": "example",
"sequenceId": "example",
"farewellMessage": "example",
"createdAt": "2026-04-15T12:00:00Z",
"updatedAt": "2026-04-15T12:00:00Z"
}

Closing reason name already in use, or closing reason is used by a channel inactivity policy