Skip to content

Mark an entitlement fulfilled

Vendors module

POST/sponsor-entitlements/{id}/fulfillsponsorEntitlements.fulfill

Stamps `fulfilled_at` now. Needs vendors.entitlement.write on the project. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requires the capability vendors.entitlement.write.
  • OAuth scopes: vendors.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

sponsorEntitlements.fulfill: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the sponsor entitlement.

Response 200: SponsorEntitlement

sponsorEntitlements.fulfill: SponsorEntitlement
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the sponsor entitlement.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
descriptionstringYesThe entitlement.Constraints: length 1 to 500
quantitynumber | nullYesCommitted quantity.
project_idstring (uuid)YesIdentifier of the project the entitlement is delivered on.
counterparty_idstring (uuid)YesIdentifier of the sponsor counterparty.
due_onstring (date) | nullYesWhen the entitlement is owed.
fulfilled_atstring (date-time) | nullYesWhen it was delivered; null while owed.
{
  "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",
  "description": "Logo on the main stage scrims.",
  "quantity": 12,
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "due_on": "2026-10-08",
  "fulfilled_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X POST "$XOS_BASE_URL/sponsor-entitlements/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/fulfill" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
const { data } = await xos.sponsorEntitlements.fulfill("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.sponsor_entitlements.fulfill("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos sponsor-entitlements fulfill 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f