Skip to main content
PUT
La anulación afecta únicamente al contacto dentro del lote indicado. Identifica el contacto en el body mediante uno de estos campos:
  • identifier: identificador externo definido en el sistema de origen. Es la opción recomendada para integrar un CRM u otro sistema externo.
  • contactId: identificador interno generado por Inagent.
Envía exactamente uno de los dos campos. Puedes añadir reason para dejar registrado el motivo de la anulación.
identifier
Para excluir una dirección de toda la cuenta, utiliza el endpoint de bloqueo. Anular un contacto solo impide que vuelva a llamarse dentro de este lote; la dirección continúa disponible para otros lotes.

Authorizations

apikey
string
header
required

API key obtenida desde la interfaz de Inagent, dentro del marcador.

Headers

Idempotency-Key
string

Clave para hacer el reintento seguro. Opcional.

Un UUID por operación lógica, reusado en los reintentos de ese mismo envío. Ver "Reintentos seguros" en la descripción de la API.

Maximum string length: 255
Pattern: ^[\x20-\x7E]+$

Path Parameters

batchId
string<uuid>
required

Id del lote.

Body

application/json
identifier
string
required

Identificador del contacto en el sistema de origen.

Example:

"CLI-001"

contactId
string<uuid>

Identificador interno asignado por Inagent al importar el contacto.

Example:

"7d2f8a1b-3c4e-4f50-9a6b-2c3d4e5f6a7b"

reason
string

Motivo de la anulación. Queda registrado en la dirección que iba a marcarse y aparece en el detalle del contacto. Es informativo.

Example:

"El cliente ya regularizó su deuda"

Response

Anulación aceptada.

contactId
string<uuid>
required
batchId
string<uuid>
required
cancelled
boolean
required
status
enum<string>
required

Estado en el que queda el contacto. finished es un estado final y excluye al contacto de la marcación.

Available options:
finished
result
enum<string>
required

Último resultado registrado del contacto. Permite distinguir una anulación de un cierre por intentos agotados.

Available options:
CANCELLED_BY_USER
reason
string