Auth & Identidade
Gestão de Acesso
Faturamento
Finalizar Cancelamento de Offboarding
curl --request POST \
--url https://api.example.com/organizations/{organizationId}/offboarding-requests/{offboardingRequestId}/finalize \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"cancelledReason": "<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": "CHURNED",
"status": "CANCELLED",
"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": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
"cancelledBySystem": false,
"cancelledReason": "cliente confirmou que quer cancelar",
"cancelledAt": "2026-03-28T10:00:00.000Z",
"cancellationDetails": null,
"createdAt": "2026-03-25T23:30:00.000Z",
"updatedAt": "2026-03-28T10:00:00.000Z"
}
Offboarding
Finalizar Cancelamento de Offboarding
Confirm the organization cancellation and finalize the offboarding process.
POST
/
organizations
/
{organizationId}
/
offboarding-requests
/
{offboardingRequestId}
/
finalize
Finalizar Cancelamento de Offboarding
curl --request POST \
--url https://api.example.com/organizations/{organizationId}/offboarding-requests/{offboardingRequestId}/finalize \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"cancelledReason": "<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": "CHURNED",
"status": "CANCELLED",
"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": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
"cancelledBySystem": false,
"cancelledReason": "cliente confirmou que quer cancelar",
"cancelledAt": "2026-03-28T10:00:00.000Z",
"cancellationDetails": null,
"createdAt": "2026-03-25T23:30:00.000Z",
"updatedAt": "2026-03-28T10:00:00.000Z"
}
Requer permissao
offboarding:finalize.Headers
Bearer token.
Parametros de Path
Organization ID (UUIDv7).
Offboarding request ID (UUIDv7).
Corpo da Requisicao
The reason for finalizing the cancellation.
Resposta
Offboarding request ID (UUIDv7).
Organization ID (UUIDv7).
The offboarding action.
The primary reason.
Additional detail.
Notas em texto livre.
The campaign mode.
The billing mode.
The billing behavior.
O prazo de retencao (ISO 8601).
The retention resolution.
The offboarding request status.
User ID (UUIDv7) who requested.
Request timestamp (ISO 8601).
User ID (UUIDv7) who resolved.
Resolution timestamp (ISO 8601).
User ID (UUIDv7) who cancelled.
Whether cancelled by system.
Motivo do cancelamento.
Cancellation timestamp (ISO 8601).
Additional cancellation details.
Timestamp de criacao (ISO 8601).
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": "CHURNED",
"status": "CANCELLED",
"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": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
"cancelledBySystem": false,
"cancelledReason": "cliente confirmou que quer cancelar",
"cancelledAt": "2026-03-28T10:00:00.000Z",
"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/finalize \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"cancelledReason": "Client confirmed cancellation"
}'
Finalizing the offboarding cancellation is irreversible. The organization’s subscription will be cancelled and campaigns will be permanently deactivated.
Codigos de Erro
| Status | Codigo | Descricao |
|---|---|---|
400 | validation_error | Entrada invalida ou campos obrigatorios ausentes |
401 | unauthorized | Autenticacao ausente ou invalida |
403 | forbidden | Permissoes insuficientes |
404 | organization.not_found | Organizacao nao encontrada |
404 | offboarding.not_found | Solicitacao de offboarding nao encontrada |
500 | internal_server_error | Ocorreu um erro inesperado |
⌘I
Assistant
Responses are generated using AI and may contain mistakes.