Developers
Diamonds18

List Diamonds

GET/automations/diamond

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.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "id"
  • "-id"
product_id?string

Only Diamonds of the product with this public ID.

showcase_id?string

Only Diamonds of the showcase with this public ID.

status?string

Only Diamonds with this status.

Value in

  • "active"
  • "inactive"
deleted?boolean

When true, returns only items in the trash. Items in the trash are excluded by default.

Header Parameters

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

application/json

curl -X GET "https://example.com/automations/diamond"
{  "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"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Diamonds18

Diamonds in API v3: list diamonds, create a diamond, retrieve a diamond, update a diamond, delete a diamond, list memberships, create a membership, retrieve a membership, update a membership stage, list processing attempts, create a processing attempt, retrieve a processing attempt, list stages, update a stage, list triggers, ensure a stage trigger, retrieve a trigger, update a trigger.

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.