update_media_buy. Only the fields you provide are updated; omitted fields remain unchanged.
Schema
- Request:
update-rights-request.json - Response:
update-rights-response.json
Response time
Seconds for most updates. Pricing changes may require rights holder approval and take longer.Quick start
Parameters
Request
| Field | Type | Required | Description |
|---|---|---|---|
rights_id | string | Yes | Rights grant identifier from acquire_rights |
end_date | date | No | New end date (must be >= current end date) |
impression_cap | integer | No | New impression cap (must be >= impressions already delivered) |
pricing_option_id | string | No | Switch to a different pricing option from the original get_rights offering |
paused | boolean | No | Pause (true) or resume (false) the grant |
idempotency_key | string | No | Client-generated key for safe retries |
Response
| Field | Type | Description |
|---|---|---|
rights_id | string | The updated rights grant identifier |
terms | object | Updated contractual terms (same shape as acquire_rights acquired response) |
generation_credentials | array | Re-issued credentials with updated expiration and caps |
rights_constraint | object | Updated constraint for re-embedding in creative manifests |
paused | boolean | Whether the grant is currently paused (included when pause state changes) |
implementation_date | datetime|null | When changes take effect (null if pending approval) |
Re-issued credentials
When you extend dates or change pricing, the rights agent re-issues generation credentials with updated expiration. Both old and new credentials may work during an overlap period — old credentials remain valid until their original expiry. Replace credentials in your creative pipeline promptly, but there is no hard cutover moment that would break in-flight generation requests. The updatedrights_constraint should replace the constraint in any active creative manifests so downstream systems see the current terms.
Next steps
acquire_rights
The initial rights acquisition flow.
report_usage
Report impressions against rights grants.