Retrieve a Diamond
/automations/diamond/{diamond_id}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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/automations/diamond/string"{ "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" }}Create a Diamond POST
Creates a Diamond automation from an existing showcase. The operation also creates the Diamond's product, its three lessons, the internal delivery that grants access to those lessons, and one trigger for each of the eleven stages. Credentials scoped to the showcase can access all of these resources. In addition to `diamonds.create`, this operation requires the `products.create` and `deliveries.create` permissions.
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.