Skip to main content
POST
/
organizations
/
{organizationId}
/
offboarding-requests
Criar Solicitacao de Offboarding
curl --request POST \
  --url https://api.example.com/organizations/{organizationId}/offboarding-requests \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "<string>",
  "reason": "<string>",
  "reasonDetail": "<string>",
  "notes": "<string>",
  "campaignMode": "<string>",
  "billingMode": "<string>",
  "billingBehavior": "<string>",
  "retentionDeadline": "<string>"
}
'
{
  "offboardingRequestId": "019525fe-4b30-7cb6-beda-6e8f0a2c4d6a",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "action": "START_RETENTION",
  "reason": "UNSATISFACTORY_RESULT",
  "reasonDetail": "Nao atingiu as metas esperadas",
  "notes": null,
  "campaignMode": "SUSPENDED",
  "billingMode": "FREE",
  "billingBehavior": "keep_as_draft",
  "retentionDeadline": "2026-04-24T23:30:00.000Z",
  "retentionResolution": null,
  "status": "IN_RETENTION",
  "requestedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "requestedAt": "2026-03-25T23:30:00.000Z",
  "resolvedBy": null,
  "resolvedAt": null,
  "cancelledBy": null,
  "cancelledBySystem": null,
  "cancelledReason": null,
  "cancelledAt": null,
  "cancellationDetails": null,
  "createdAt": "2026-03-25T23:30:00.000Z",
  "updatedAt": "2026-03-25T23:30:00.000Z"
}
Requer permissao offboarding:write.

​
Headers

​
Authorization
string
required
Bearer token.

​
Parametros de Path

​
organizationId
string
required
UUID da organizacao.

​
Corpo da Requisicao

​
action
string
required
A acao de offboarding. Um de: CANCEL_NOW, START_RETENTION.
​
reason
string
required
O motivo principal do offboarding.
​
reasonDetail
string
required
Detalhe adicional sobre o motivo.
​
notes
string
Notas em texto livre.
​
campaignMode
string
The campaign mode to apply during retention. One of: SUSPENDED, INACTIVE. Required when action is START_RETENTION.
​
billingMode
string
The billing mode to apply during retention. One of: CHARGED, FREE. Required when action is START_RETENTION.
​
billingBehavior
string
The billing behavior when billing mode is FREE. One of: keep_as_draft, mark_uncollectible. Required when billing mode is FREE.
​
retentionDeadline
string
O prazo de retencao (ISO 8601). Required when action is START_RETENTION.

​
Resposta

​
offboardingRequestId
string
UUID da solicitacao de offboarding.
​
organizationId
string
UUID da organizacao.
​
action
string
The offboarding action.
​
reason
string
The primary reason.
​
reasonDetail
string|null
Additional detail.
​
notes
string|null
Notas em texto livre.
​
campaignMode
string|null
The campaign mode.
​
billingMode
string|null
The billing mode.
​
billingBehavior
string|null
The billing behavior.
​
retentionDeadline
string|null
O prazo de retencao (ISO 8601).
​
retentionResolution
string|null
The retention resolution.
​
status
string
The offboarding request status.
​
requestedBy
string
User UUID who requested.
​
requestedAt
string
Request timestamp (ISO 8601).
​
resolvedBy
string|null
User UUID who resolved.
​
resolvedAt
string|null
Resolution timestamp (ISO 8601).
​
cancelledBy
string|null
User UUID who cancelled.
​
cancelledBySystem
boolean|null
Whether cancelled by system.
​
cancelledReason
string|null
Motivo do cancelamento.
​
cancelledAt
string|null
Cancellation timestamp (ISO 8601).
​
cancellationDetails
object|null
Additional cancellation details.
​
createdAt
string
Timestamp de criacao (ISO 8601).
​
updatedAt
string
Timestamp da ultima atualizacao (ISO 8601).
{
  "offboardingRequestId": "019525fe-4b30-7cb6-beda-6e8f0a2c4d6a",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "action": "START_RETENTION",
  "reason": "UNSATISFACTORY_RESULT",
  "reasonDetail": "Nao atingiu as metas esperadas",
  "notes": null,
  "campaignMode": "SUSPENDED",
  "billingMode": "FREE",
  "billingBehavior": "keep_as_draft",
  "retentionDeadline": "2026-04-24T23:30:00.000Z",
  "retentionResolution": null,
  "status": "IN_RETENTION",
  "requestedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "requestedAt": "2026-03-25T23:30:00.000Z",
  "resolvedBy": null,
  "resolvedAt": null,
  "cancelledBy": null,
  "cancelledBySystem": null,
  "cancelledReason": null,
  "cancelledAt": null,
  "cancellationDetails": null,
  "createdAt": "2026-03-25T23:30:00.000Z",
  "updatedAt": "2026-03-25T23:30:00.000Z"
}

​
Exemplos de Codigo

curl -X POST https://api.awsales.io/admin/organizations/019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2/offboarding-requests \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "START_RETENTION",
  "reason": "HIGH_COST",
  "reasonDetail": "Budget constraints",
  "campaignMode": "SUSPENDED",
  "billingMode": "FREE",
  "billingBehavior": "keep_as_draft",
  "retentionDeadline": "2026-04-24T23:30:00.000Z"
}'
Use START_RETENTION to give the organization a grace period before cancellation. Use CANCEL_NOW only when immediate cancellation is confirmed.

​
Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
404organization.not_foundOrganizacao nao encontrada
500internal_server_errorOcorreu um erro inesperado