Developers
Diamonds

Update a Diamond

PATCH/automations/diamond/{diamond_id}

Updates the name, status, or stage intervals of a Diamond. Stage intervals can be updated partially.

Updating status also requires the diamonds.activate permission.

Interval changes apply to future scheduling; communications already scheduled for leads are not affected.

Send the current ETag 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

diamond_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

application/json

curl -X PATCH "https://example.com/automations/diamond/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "deleted": true,    "delivery_id": "string",    "id": "string",    "lesson_ids": [      "string"    ],    "memberships_count": 0,    "name": "string",    "object": "diamond",    "product_id": "string",    "revision": "string",    "settings": {      "expected_delivery": "string",      "steps_interval": {        "property1": 0,        "property2": 0      }    },    "showcase_id": "string",    "status": "active",    "type": "diamond",    "updated_at": "2019-08-24T14:15:22Z"  }}

Retrieve a Diamond GET

Retrieves a Diamond with its settings and the IDs of its related product, showcase, delivery, and lessons. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the Diamond or one of its stages to avoid overwriting a newer version.

Delete a Diamond DELETE

Moves the Diamond to the trash. A Diamond that still has memberships cannot be deleted, and deletion cannot be forced. Such requests return the `state_conflict` error code.