Skip to main content
PATCH
Update an entitlement
Only entitlements with a status of pending can be updated. Attempting to update an entitlement in any other state returns an error. Use the optional update_mask query parameter to specify exactly which fields to update. See the update_mask parameter reference for the supported values.

Authorizations

Authorization
string
header
required

Bearer token authentication. When a distributor is registered, they receive an opaque bearer token (prefixed op_b_). Include it in the Authorization header of every request as Bearer <token>.

Path Parameters

distributor-customer
string
required

The customer ID, as defined in the distributor's own system.

entitlement
string
required

The entitlement ID.

Query Parameters

update_mask
string

An optional comma-separated list of fields to update. If omitted, any supported fields provided in the request body are updated. Supported values: contact_info.email, contact_info.company_name, contact_info, and *.

Body

application/json

The entitlement resource containing the updated field values.

A provisioned 1Password product entitlement for a distributor customer.

product_id
string

The ID of the 1Password product. Required on create; immutable thereafter.

contact_info
object

The customer's contact details for account setup.

Response

The updated entitlement.

A provisioned 1Password product entitlement for a distributor customer.

path
string
read-only

The canonical resource path of the entitlement (for example, "distributor-customers/{customer_id}/entitlements/{id}"). Use the IDs in this path to update or cancel the entitlement.

id
string
read-only

The unique identifier for this entitlement.

customer_id
string
read-only

The ID of the marketplace customer who owns this entitlement. This is the distributor-defined ID from the request path that created the entitlement.

product_id
string

The ID of the 1Password product. Required on create; immutable thereafter.

status
enum<string>
read-only

The entitlement lifecycle state.

Available options:
pending,
active,
cancelling,
cancelled,
expired,
suspended
contact_info
object

The customer's contact details for account setup.

create_time
string<date-time>
read-only

The date and time the entitlement was created.

expire_time
string<date-time>
read-only

The date and time the entitlement expires. Set only for change-of-channel entitlements created by linking an entitlement, and omitted for standard entitlements. Customers have 5 days to claim the emailed entitlement code against their existing 1Password account. Claiming the code completes the link; otherwise, the entitlement transitions to expired at this time.