Create a Diamond
/automations/diamondCreates 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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Header Parameters
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
curl -X POST "https://example.com/automations/diamond" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "showcase_id": "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" }}List Diamonds GET
Returns the Diamonds accessible with the current credentials, paginated by cursor. Credentials scoped to specific showcases or products only see the Diamonds that belong to them. The collection can be filtered by product, showcase, status, and deletion state.
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.