Pausar

Pausa uma negociação em andamento, interrompendo a atuação do agente.

POSThttps://external-api.arbitralis.com.br/api/external/v1/extrajudicial/negotiations/{id}/pause

AutenticaçãoX-API-KEYSíncrono — a resposta já traz o resultado

Pausa uma negociação em andamento (ACTIVE → PAUSED). O agente para de enviar mensagens e de responder à contraparte até que a negociação seja retomada.

Use quando o devedor entrar em contato por outro canal, quando houver uma tratativa jurídica paralela, ou quando o pagamento estiver em análise.

Parâmetros de rota

iduuidobrigatório

Identificador do caso de negociação.

Não há corpo de requisição.

Quando não é possível pausar

Status atual	Pausar
`ACTIVE`	Sim
`STARTED`	Sim
`PAUSED`	Já está pausada
`SCHEDULED`	Não — a negociação ainda não começou
`AGREEMENT_CLOSED`, `NO_AGREEMENT`, `CLOSED`	Não — já encerrada
Arquivada	Não

Pausar não encerra

A pausa é reversível: use Retomar para reativar o agente. Para finalizar definitivamente o caso, use Encerrar.

Mensagens recebidas durante a pausa

Enquanto pausada, a negociação não recebe atuação do agente — mensagens que a contraparte enviar ficam na conversa aguardando tratamento humano ou a retomada.

Erros

Código	Causa
`400`	Status atual não permite pausa
`401`	API key ausente, inválida ou inativa
`404`	Negociação não encontrada neste workspace
`429`	Limite de requisições excedido

Requisição

curl -X POST "https://external-api.arbitralis.com.br/api/external/v1/extrajudicial/negotiations/1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d/pause" \
  -H "X-API-KEY: arb_live_SUA_CHAVE"

const negociacaoId = '1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d';

const response = await fetch(
  `https://external-api.arbitralis.com.br/api/external/v1/extrajudicial/negotiations/${negociacaoId}/pause`,
  {
    method: 'POST',
    headers: { 'X-API-KEY': 'arb_live_SUA_CHAVE' },
  }
);

const { data } = await response.json();

import requests

negociacao_id = "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"

response = requests.post(
    f"https://external-api.arbitralis.com.br/api/external/v1/extrajudicial/negotiations/{negociacao_id}/pause",
    headers={"X-API-KEY": "arb_live_SUA_CHAVE"},
)

data = response.json()["data"]

Resposta

{
  "success": true,
  "data": {
    "negociacaoId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "status": "PAUSED"
  }
}