Create a sponsor entitlement
Vendors module
POST/sponsor-entitlementssponsorEntitlements.create
A sponsor entitlement with fulfillment tracking. Creates a sponsor entitlement. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- 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, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: SponsorEntitlementCreate
| Field | Type | Required | Description |
|---|---|---|---|
| description | string | Yes | The entitlement.Constraints: length 1 to 500 |
| quantity | number | null | No | 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 | No | When the entitlement is owed. |
{
"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"
}Response 201: 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 POST "$XOS_BASE_URL/sponsor-entitlements" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"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"}'const { data } = await xos.sponsorEntitlements.create({
"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"
});response = xos.sponsor_entitlements.create({"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"})xos sponsor-entitlements create --data '{"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"}'