Developers
Products19

Update an access schedule

PATCH/products/{product_id}/access-schedules/{access_schedule_id}

Renames or restores an access schedule.

The access schedule takes its name from its tag, so changing name renames the tag everywhere it is used and also requires the tags.update permission. Setting deleted to false restores an access schedule from the trash.

Replicated access schedules are read-only and return the replica_readonly error code.

Send the current ETag value in the If-Match header to avoid overwriting a newer version.

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

product_id*string

Public ID of the product, prefixed with prd_.

access_schedule_id*string

Public ID of the access schedule, prefixed with acs_.

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. * matches the current revision. Any other value fails with 400 and the if_match_invalid 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

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/products/string/access-schedules/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "default": true,    "deleted": true,    "deliveries": [      {        "id": "string"      }    ],    "deliveries_count": 0,    "id": "string",    "name": "string",    "object": "access_schedule",    "product_id": "string",    "revision": "string",    "rules_count": 0,    "tag_id": "string",    "updated_at": "2019-08-24T14:15:22Z"  }}

Retrieve an access schedule GET

Retrieves an access schedule by its public ID, including the deliveries that use it (`deliveries[]`). The response includes an `ETag` representing the current revision of the access schedule. Send this value in the `If-Match` header when updating the access schedule or its release rules to avoid overwriting a newer version.

Delete an access schedule DELETE

Moves the access schedule to the trash. The default access schedule cannot be deleted and returns the `state_conflict` error code. An access schedule in use by a delivery that is not archived cannot be deleted either and also returns `state_conflict`. Replicated access schedules are read-only and return the `replica_readonly` error code.