Service request decline reasons

Base URL: $BUSINESS_API

The object

reasonsarray of DeclineReason · required
Show child attributes
codestring · required
labelstring · required
activeboolean · required
positioninteger · optional
customizedboolean · required

False while the tenant still uses the shipped template

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

Get service request decline reasons

Logs

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.

Returns

200 Decline reasons

Show attributes
reasonsarray of DeclineReason · required
Show child attributes
codestring · required
labelstring · required
activeboolean · required
positioninteger · optional
customizedboolean · required

False while the tenant still uses the shipped template

Errors 403

Permissions connections:read · Roles: admin, analyst, customer_service, operations, owner, viewer

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

Replace the tenant's decline reasons

Logs

PUT /service-request-decline-reasons

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

Body application/json

reasonsarray of DeclineReason · required
Show child attributes
codestring · required
labelstring · required
activeboolean · required
positioninteger · optional

Returns

200 Saved reasons

Show attributes
reasonsarray of DeclineReason · required
Show child attributes
codestring · required
labelstring · required
activeboolean · required
positioninteger · optional
customizedboolean · required

False while the tenant still uses the shipped template

Errors 400 · 403

Permissions connections:write · Roles: 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
    }
  ]
}'
Response 200
{
  "reasons": [
    {
      "code": "COD-2026-000142",
      "label": "label",
      "active": true,
      "position": 1
    }
  ],
  "customized": true
}