Developers
Diamonds18

Delete a Diamond

DELETE/automations/diamond/{diamond_id}

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.

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

Public ID of the diamond, prefixed with dmd_.

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.

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/automations/diamond/string"
Empty

Update a Diamond PATCH

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.

List memberships GET

Returns the leads in a Diamond, paginated by cursor. The collection can be filtered by user, stage, and last update time. Credentials scoped to specific users only see the memberships of those users.