Developers
Deliveries

Replace delivery release schedules

PUT/sales/deliveries/{delivery_id}/rules

Replaces the release schedules applied by the delivery.

Changes apply only to new enrollments. Existing enrollments keep the release schedule assigned when they were granted.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

delivery_id*string

Header Parameters

Idempotency-Key?string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

If-Match?string

Expected revision of the resource, in the same format as the ETag header (W/"<type>:<id>:<revision>"). If the resource has changed since that revision, the request fails with 412 and the revision_mismatch error code. When omitted, the update is applied to the current revision.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/sales/deliveries/string/rules" \  -H "Content-Type: application/json" \  -d '{    "entries": [      {        "product_id": "string",        "schedule_id": "string"      }    ]  }'
{  "data": {    "entries": [      {        "links": {          "schedule": "string"        },        "product_id": "string",        "schedule_id": "string"      }    ],    "object": "delivery_rules"  }}

List delivery release schedules GET

Returns the release schedules applied by the delivery, with one entry for each product it grants access to. Products without a release schedule are included with a null `schedule_id`, meaning their content is released without a schedule.

List delivery tags GET

Returns the tags automatically applied to users who purchase through the delivery. Deleted tags are not included, because they are no longer applied.