PT EN

Motivos de recusa

URL base: $BUSINESS_API

O objecto

reasonsarray of DeclineReason · obrigatório
Mostrar atributos filhos
codestring · obrigatório
labelstring · obrigatório
activeboolean · obrigatório
positioninteger · opcional
customizedboolean · obrigatório

False while the tenant still uses the shipped template

O objecto
{
  "reasons": [
    {
      "code": "COD-2026-000142",
      "label": "label",
      "active": true,
      "position": 1
    }
  ],
  "customized": true
}

Obter os motivos de recusa

Registos

GET /service-request-decline-reasons

List the tenant's decline reasons, or the template it starts from

Returns the reasons staff can choose when declining a new connection service request, each with a code, label, active flag and position. While the tenant has not saved its own list, the built-in template is returned and customized is false. Requires the connections:read permission.

Devolve

200 Decline reasons

Mostrar atributos
reasonsarray of DeclineReason · obrigatório
Mostrar atributos filhos
codestring · obrigatório
labelstring · obrigatório
activeboolean · obrigatório
positioninteger · opcional
customizedboolean · obrigatório

False while the tenant still uses the shipped template

Erros 403

Permissões connections:read · Funções: admin, analyst, customer_service, operations, owner, viewer

curl -X GET "$BUSINESS_API/service-request-decline-reasons" \
  -H "Authorization: Bearer sk_test_..."
Resposta 200
{
  "reasons": [
    {
      "code": "COD-2026-000142",
      "label": "label",
      "active": true,
      "position": 1
    }
  ],
  "customized": true
}

Substituir os motivos de recusa

Registos

PUT /service-request-decline-reasons

1 to 30 reasons with unique codes and labels; at least one active. Deactivate a reason to retire it.

Corpo application/json

reasonsarray of DeclineReason · obrigatório
Mostrar atributos filhos
codestring · obrigatório
labelstring · obrigatório
activeboolean · obrigatório
positioninteger · opcional

Devolve

200 Saved reasons

Mostrar atributos
reasonsarray of DeclineReason · obrigatório
Mostrar atributos filhos
codestring · obrigatório
labelstring · obrigatório
activeboolean · obrigatório
positioninteger · opcional
customizedboolean · obrigatório

False while the tenant still uses the shipped template

Erros 400 · 403

Permissões connections:write · Funções: admin, operations, owner

curl -X PUT "$BUSINESS_API/service-request-decline-reasons" \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
  "reasons": [
    {
      "code": "COD-2026-000142",
      "label": "label",
      "active": true,
      "position": 1
    }
  ]
}'
Resposta 200
{
  "reasons": [
    {
      "code": "COD-2026-000142",
      "label": "label",
      "active": true,
      "position": 1
    }
  ],
  "customized": true
}