Update a sponsor entitlement
Vendors module
PATCH/sponsor-entitlements/{id}sponsorEntitlements.update
A sponsor entitlement with fulfillment tracking. 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.
- Requires the capability vendors.entitlement.write.
- OAuth scopes: vendors.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the sponsor entitlement. |
Request body: SponsorEntitlementUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| description | string | No | The entitlement.Constraints: length 1 to 500 |
| quantity | number | null | No | Committed quantity. |
| counterparty_id | string (uuid) | No | Identifier of the sponsor counterparty. |
| due_on | string (date) | null | No | When the entitlement is owed. |
{
"description": "Logo on the main stage scrims.",
"quantity": 12,
"counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"due_on": "2026-10-08"
}Response 200: SponsorEntitlement
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the sponsor entitlement. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| description | string | Yes | The entitlement.Constraints: length 1 to 500 |
| quantity | number | null | Yes | Committed quantity. |
| project_id | string (uuid) | Yes | Identifier of the project the entitlement is delivered on. |
| counterparty_id | string (uuid) | Yes | Identifier of the sponsor counterparty. |
| due_on | string (date) | null | Yes | When the entitlement is owed. |
| fulfilled_at | string (date-time) | null | Yes | When 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 PATCH "$XOS_BASE_URL/sponsor-entitlements/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 '{"description":"Logo on the main stage scrims.","quantity":12,"counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","due_on":"2026-10-08"}'const { data, etag } = await xos.sponsorEntitlements.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"description": "Logo on the main stage scrims.",
"quantity": 12,
"counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"due_on": "2026-10-08"
}, { ifMatch: etag });response = xos.sponsor_entitlements.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"description": "Logo on the main stage scrims.", "quantity": 12, "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "due_on": "2026-10-08"}, if_match=etag)xos sponsor-entitlements update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"description":"Logo on the main stage scrims.","quantity":12,"counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","due_on":"2026-10-08"}' --if-match auto