Upsert entitlement
UpsertEntitlement
Upserts a new entitlement or updates an existing entitlement.
Note: If you wish to invalidate an existing entitlement, set the expires_at field to any moment in the past.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Entitlements represent an end-users permission to access event or creative work content.
The offer that the user is entitled to access. For more information, see Offer.
The ID of the user who is entitled to access the content. The user ID must be contained in the JWT token that the user authenticates with on the content-delivery API.
The amount of devices that can concurrently view the content associated with this entitlement from a single account. If not provided, there is no limit. This typically refers to the number of devices that can concurrently view the content associated with the offer, but may deviate in certain conditions (e.g. when the entitlement is created via this API and should have a different limit, or when the offer's concurrency limit has changed since the original entitlement was created).
The time at which the entitlement is no longer valid. If not provided, the entitlement will not expire.
The two-character ISO 3166-1 alpha-2 country code of the country where the user obtained the entitlement. This may be used to bypass geo-restrictions in certain conditions, e.g. when the user is traveling and is protected by EU regulations (https://europa.eu/youreurope/citizens/consumers/internet-telecoms/access-online-content-abroad/index_en.htm). If not provided, the entitlement will not be able to bypass geo-restrictions.
An identifier of the source of the entitlement. For example, the Cleeng transaction ID or the Motto transaction ID.
A string representing the type of the source of the entitlement. For example, cleeng or motto.
Response
Entitlements represent an end-users permission to access event or creative work content.