Saltar al contenido
XOS para desarrolladores

Delete an advance recipient

Módulo Advancing

DELETE/advance-recipients/{id}advanceRecipients.delete

A party bound to an advance packet. Recipients without an account use a token and access code. Soft-deletes the advance recipient: it moves to Trash and can be restored for its table's retention period.

  • Requiere la capacidad advancing.packet.write.
  • Alcances de OAuth: advancing.
  • Estados de error: 401, 404, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

advanceRecipients.delete: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the advance recipient.

Respuesta 204: sin cuerpo.

Ejemplos de código

curl -X DELETE "$XOS_BASE_URL/advance-recipients/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.advanceRecipients.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.advance_recipients.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos advance-recipients delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f