sponsorEntitlements
Vendors module · 7 operations
List sponsor entitlement rows
GET/sponsor-entitlements
A sponsor entitlement with fulfillment tracking. Returns a cursor page of sponsor entitlement rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
Create a sponsor entitlement
POST/sponsor-entitlements
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.
Get a sponsor entitlement
GET/sponsor-entitlements/{id}
A sponsor entitlement with fulfillment tracking. Returns one sponsor entitlement with its `ETag`. A sponsor entitlement the caller may not see returns 404.
Update a sponsor entitlement
PATCH/sponsor-entitlements/{id}
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.
Delete a sponsor entitlement
DELETE/sponsor-entitlements/{id}
A sponsor entitlement with fulfillment tracking. Soft-deletes the sponsor entitlement: it moves to Trash and can be restored for its table's retention period.
Mark an entitlement fulfilled
POST/sponsor-entitlements/{id}/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`.
Mark an entitlement owed again
POST/sponsor-entitlements/{id}/reopen
Clears `fulfilled_at`. 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`.