Decline an offer

Módulo People

POST/offers/{id}/declineoffers.decline

The applicant side declines the organization's terms; the offer and the application become Declined. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requiere la capacidad me.work_details.write.
Alcances de OAuth: me.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 404, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

offers.decline: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the offer.

Cuerpo de la solicitud: OfferDeclineRequest

offers.decline: OfferDeclineRequest
Campo	Tipo	Obligatorio	Descripción
reason	string	Sí	Why, recorded on the offer's state transition.Restricciones: length 1 to 2000

{
  "reason": "The dates conflict with another booking."
}

Respuesta 200: Offer

offers.decline: Offer
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the offer.
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.
application_id	string (uuid)	Sí	Identifier of the application the offer answers.
person_id	string (uuid) \| null	Sí	Identifier of the offered person.
organization_id	string (uuid) \| null	Sí	Identifier of the offered organization.
rate_type	RateType \| null	Sí
expires_at	string (date-time) \| null	Sí	When the terms in force lapse unanswered.
offer_state	string	Sí	Offer state. A Title Case value from the lifecycle's database enum.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$
responded_at	string (date-time) \| null	Sí	When the offer was answered.
version_number	integer	Sí	Version of the terms in force, issued by the database; the highest is in force.Restricciones: range 0 to any
proposed_side	"Organization" \| "Party"	Sí	Side that proposed the terms in force.
amount_minor	integer (int64) \| null	Sí	Offered amount per rate unit; null when the version leaves the amount open. Integer minor units of the resource currency; null means unpriced, never zero.
currency_code	string \| null	Sí	ISO 4217 currency of the amount.Restricciones: pattern ^[A-Z]{3}$
starts_on	string (date) \| null	Sí	First day of the work offered.
ends_on	string (date) \| null	Sí	Last day of the work offered.
message	string \| null	Sí	Message to the other side with the terms. Visible to both sides.Restricciones: length 1 to 4000

{
  "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",
  "application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "rate_type": "Day",
  "expires_at": "2026-10-08T14:30:00Z",
  "offer_state": "Active",
  "responded_at": "2026-10-08T14:30:00Z",
  "version_number": 1,
  "proposed_side": "Organization",
  "amount_minor": 45000,
  "currency_code": "USD",
  "starts_on": "2026-10-08",
  "ends_on": "2026-10-08",
  "message": "Rate includes the load-in day."
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/offers/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/decline" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"reason":"The dates conflict with another booking."}'

const { data } = await xos.offers.decline("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "reason": "The dates conflict with another booking."
  });

response = xos.offers.decline("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"reason": "The dates conflict with another booking."})

xos offers decline 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"reason":"The dates conflict with another booking."}'