Skip to main content
POST
/
organizations
/
{organizationId}
/
offboarding-requests
/
{offboardingRequestId}
/
retain
Reter Solicitacao de Offboarding
curl --request POST \
  --url https://api.example.com/organizations/{organizationId}/offboarding-requests/{offboardingRequestId}/retain \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "notes": "<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": "cliente aceitou desconto de 20%",
  "campaignMode": "SUSPENDED",
  "billingMode": "FREE",
  "billingBehavior": "keep_as_draft",
  "retentionDeadline": "2026-04-24T23:30:00.000Z",
  "retentionResolution": "RETAINED",
  "status": "RETAINED",
  "requestedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "requestedAt": "2026-03-25T23:30:00.000Z",
  "resolvedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "resolvedAt": "2026-03-28T10:00:00.000Z",
  "cancelledBy": null,
  "cancelledBySystem": null,
  "cancelledReason": null,
  "cancelledAt": null,
  "cancellationDetails": null,
  "createdAt": "2026-03-25T23:30:00.000Z",
  "updatedAt": "2026-03-28T10:00:00.000Z"
}
Requer permissao offboarding:retain.

​
Headers

​
Authorization
string
required
Bearer token.

​
Parametros de Path

​
organizationId
string
required
Organization ID (UUIDv7).
​
offboardingRequestId
string
required
Offboarding request ID (UUIDv7).

​
Corpo da Requisicao

​
notes
string
Free-text notes about the retention.

​
Resposta

​
offboardingRequestId
string
Offboarding request ID (UUIDv7).
​
organizationId
string
Organization ID (UUIDv7).
​
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 ID (UUIDv7) who requested.
​
requestedAt
string
Request timestamp (ISO 8601).
​
resolvedBy
string|null
User ID (UUIDv7) who resolved.
​
resolvedAt
string|null
Resolution timestamp (ISO 8601).
​
cancelledBy
string|null
User ID (UUIDv7) 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": "cliente aceitou desconto de 20%",
  "campaignMode": "SUSPENDED",
  "billingMode": "FREE",
  "billingBehavior": "keep_as_draft",
  "retentionDeadline": "2026-04-24T23:30:00.000Z",
  "retentionResolution": "RETAINED",
  "status": "RETAINED",
  "requestedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "requestedAt": "2026-03-25T23:30:00.000Z",
  "resolvedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
  "resolvedAt": "2026-03-28T10:00:00.000Z",
  "cancelledBy": null,
  "cancelledBySystem": null,
  "cancelledReason": null,
  "cancelledAt": null,
  "cancellationDetails": null,
  "createdAt": "2026-03-25T23:30:00.000Z",
  "updatedAt": "2026-03-28T10:00:00.000Z"
}

​
Exemplos de Codigo

curl -X POST https://api.awsales.io/admin/organizations/019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2/offboarding-requests/019525fe-4b30-7cb6-beda-6e8f0a2c4d6a/retain \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "notes": "Client accepted 20% discount"
}'

​
Codigos de Erro

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