Update an advance packet

Módulo Advancing

PATCH/advance-packets/{id}advancePackets.update

An advance packet sent to parties for one project. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Requiere la capacidad advancing.packet.write.
Alcances de OAuth: advancing.
Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

advancePackets.update: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the advance packet.

Cuerpo de la solicitud: AdvancePacketUpdate

advancePackets.update: AdvancePacketUpdate
Campo	Tipo	Obligatorio	Descripción
title	string	No	Packet title.Restricciones: length 1 to 300
due_at	string (date-time) \| null	No	When submissions are due.

{
  "title": "Headliner Advance",
  "due_at": "2026-10-08T14:30:00Z"
}

Respuesta 200: AdvancePacket

advancePackets.update: AdvancePacket
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the advance packet.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_id	string (uuid)	Sí	Identifier of the project.
title	string	Sí	Packet title.Restricciones: length 1 to 300
due_at	string (date-time) \| null	Sí	When submissions are due.
sent_at	string (date-time) \| null	Sí	When the packet was sent.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "title": "Headliner Advance",
  "due_at": "2026-10-08T14:30:00Z",
  "sent_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/advance-packets/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"title":"Headliner Advance","due_at":"2026-10-08T14:30:00Z"}'

const { data, etag } = await xos.advancePackets.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "title": "Headliner Advance",
    "due_at": "2026-10-08T14:30:00Z"
  }, { ifMatch: etag });

response = xos.advance_packets.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"title": "Headliner Advance", "due_at": "2026-10-08T14:30:00Z"}, if_match=etag)

xos advance-packets update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"title":"Headliner Advance","due_at":"2026-10-08T14:30:00Z"}' --if-match auto