PATCH /v1/closing-reasons/{id}
PATCH
/v1/closing-reasons/{id}
const url = 'https://seu-endereco-da-api/v1/closing-reasons/example';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"example","active":true,"sortOrder":1,"csatSurveyId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","sequenceId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","farewellMessage":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”id
required
string
Request Bodyrequired
Seção intitulada “Request Bodyrequired”Media typeapplication/json
object
name
string
active
boolean
sortOrder
number
csatSurveyId
string format: uuid
sequenceId
string format: uuid
farewellMessage
string
Example generated
{ "name": "example", "active": true, "sortOrder": 1, "csatSurveyId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "sequenceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "farewellMessage": "example"}Responses
Seção intitulada “Responses”Media typeapplication/json
object
id
required
string
name
required
string
active
required
boolean
sortOrder
required
number
csatSurveyId
required
string
sequenceId
required
Sequence the contact enters when a conversation is closed with this reason
string
farewellMessage
required
string
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