Automations API

11 operations. Guide: Automate email from events. Requests and responses are JSON with snake_case fields; authenticate with Authorization: Bearer <api key>. The examples assume a client built as in SDKs and the command line.

Create an automation (draft)

POST /v1/automations

Operation createAutomation, SDK minket.automations.create. Keys: full access. Live keys only: test keys get 403 test_mode_only.

Request body

Field	Type	Required	Description
`name`	string	yes	1 to 200 characters.
`definition`	object	yes
`definition.trigger`	object	yes
`definition.trigger (shape 1).kind`	"custom_event"	yes
`definition.trigger (shape 1).event`	string	yes	1 to 100 characters.
`definition.trigger (shape 2).kind`	"contact_created"	yes
`definition.trigger (shape 3).kind`	"contact_updated"	yes
`definition.trigger (shape 3).properties`	array of string	no
`definition.trigger (shape 4).kind`	"topic_subscribed"	yes
`definition.trigger (shape 4).topic_id`	string	yes	A UUID.
`definition.trigger (shape 5).kind`	"segment_entered"	yes
`definition.trigger (shape 5).segment_id`	string	yes	A UUID.
`definition.trigger (shape 6).kind`	"email_event"	yes
`definition.trigger (shape 6).type`	one of "email.sent", "email.scheduled", "email.delivered", "email.delivery_delayed", "email.complained", "email.bounced", "email.opened", "email.clicked", "email.received", "email.failed", "email.suppressed", "email.canceled", …	yes
`definition.trigger (shape 6).tag`	object	no
`definition.trigger (shape 6).tag.name`	string	yes
`definition.trigger (shape 6).tag.value`	string	yes
`definition.filter`	object or null	no	Default `null`.
`definition.filter (shape 1).all`	array of object	yes	At most 50 items.
`definition.filter (shape 1).all[].field`	string	yes	At most 120 characters.
`definition.filter (shape 1).all[].op`	one of "eq", "neq", "contains", "not_contains", "starts_with", "ends_with", "gt", "gte", "lt", "lte", "is_set", "is_not_set", …	yes
`definition.filter (shape 1).all[].value`	string or number or boolean or array of string or null	no
`definition.filter (shape 2).any`	array of object	yes	At most 50 items.
`definition.filter (shape 2).any[].field`	string	yes	At most 120 characters.
`definition.filter (shape 2).any[].op`	one of "eq", "neq", "contains", "not_contains", "starts_with", "ends_with", "gt", "gte", "lt", "lte", "is_set", "is_not_set", …	yes
`definition.filter (shape 2).any[].value`	string or number or boolean or array of string or null	no
`definition.allow_reentry`	boolean	no	Default `false`.
`definition.start`	string	yes	1 to 50 characters.
`definition.steps`	array of object	yes	At most 100 items.
`definition.steps[] (shape 1).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 1).type`	"send_email"	yes
`definition.steps[] (shape 1).template_id`	string	yes	1 to 100 characters.
`definition.steps[] (shape 1).variables`	map of string or number or boolean	no
`definition.steps[] (shape 1).from`	string	no	At most 320 characters.
`definition.steps[] (shape 1).subject`	string	no	At most 998 characters.
`definition.steps[] (shape 1).reply_to`	string	no	At most 320 characters.
`definition.steps[] (shape 1).stream`	one of "transactional", "marketing"	no
`definition.steps[] (shape 1).topic_id`	string or null	no	A UUID.
`definition.steps[] (shape 1).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 2).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 2).type`	"wait"	yes
`definition.steps[] (shape 2).duration`	object	yes
`definition.steps[] (shape 2).duration.amount`	integer	yes
`definition.steps[] (shape 2).duration.unit`	one of "minutes", "hours", "days"	yes
`definition.steps[] (shape 2).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 3).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 3).type`	"wait_for_event"	yes
`definition.steps[] (shape 3).event`	one of "email.opened", "email.clicked", "custom_event"	yes
`definition.steps[] (shape 3).custom_event`	string	no	1 to 100 characters.
`definition.steps[] (shape 3).timeout`	object	yes
`definition.steps[] (shape 3).timeout.amount`	integer	yes
`definition.steps[] (shape 3).timeout.unit`	one of "minutes", "hours", "days"	yes
`definition.steps[] (shape 3).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 3).timeout_next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 4).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 4).type`	"branch"	yes
`definition.steps[] (shape 4).condition`	object	no
`definition.steps[] (shape 4).condition (shape 1).all`	array of object	yes	At most 50 items.
`definition.steps[] (shape 4).condition (shape 2).any`	array of object	yes	At most 50 items.
`definition.steps[] (shape 4).engagement`	object	no
`definition.steps[] (shape 4).engagement.event`	one of "email.opened", "email.clicked"	yes
`definition.steps[] (shape 4).engagement.step_id`	string or null	no	1 to 50 characters. Default `null`.
`definition.steps[] (shape 4).yes`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 4).no`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 5).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 5).type`	"update_contact"	yes
`definition.steps[] (shape 5).first_name`	string or null	no	At most 200 characters.
`definition.steps[] (shape 5).last_name`	string or null	no	At most 200 characters.
`definition.steps[] (shape 5).unsubscribed`	boolean	no
`definition.steps[] (shape 5).properties`	map of string or number or boolean or null	no
`definition.steps[] (shape 5).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 6).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 6).type`	"segment"	yes
`definition.steps[] (shape 6).action`	one of "add", "remove"	yes
`definition.steps[] (shape 6).segment_id`	string	yes	A UUID.
`definition.steps[] (shape 6).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 7).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 7).type`	"topic"	yes
`definition.steps[] (shape 7).action`	one of "subscribe", "unsubscribe"	yes
`definition.steps[] (shape 7).topic_id`	string	yes	A UUID.
`definition.steps[] (shape 7).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 8).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 8).type`	"delete_contact"	yes
`definition.steps[] (shape 9).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 9).type`	"exit"	yes

Response

201 Created: Automation.

Field	Type	Required	Description
`id`	string	yes	A UUID.
`object`	"automation"	yes
`project_id`	string	yes	A UUID.
`name`	string	yes
`status`	one of "draft", "active", "paused", "archived"	yes
`current_version`	integer	yes
`published_version`	integer or null	yes
`trigger`	object	yes
`trigger (shape 1).kind`	"custom_event"	yes
`trigger (shape 1).event`	string	yes	1 to 100 characters.
`trigger (shape 2).kind`	"contact_created"	yes
`trigger (shape 3).kind`	"contact_updated"	yes
`trigger (shape 3).properties`	array of string	no
`trigger (shape 4).kind`	"topic_subscribed"	yes
`trigger (shape 4).topic_id`	string	yes	A UUID.
`trigger (shape 5).kind`	"segment_entered"	yes
`trigger (shape 5).segment_id`	string	yes	A UUID.
`trigger (shape 6).kind`	"email_event"	yes
`trigger (shape 6).type`	one of "email.sent", "email.scheduled", "email.delivered", "email.delivery_delayed", "email.complained", "email.bounced", "email.opened", "email.clicked", "email.received", "email.failed", "email.suppressed", "email.canceled", …	yes
`trigger (shape 6).tag`	object	no
`trigger (shape 6).tag.name`	string	yes
`trigger (shape 6).tag.value`	string	yes
`definition`	object	yes
`definition.trigger`	object	yes
`definition.trigger (shape 1).kind`	"custom_event"	yes
`definition.trigger (shape 1).event`	string	yes	1 to 100 characters.
`definition.trigger (shape 2).kind`	"contact_created"	yes
`definition.trigger (shape 3).kind`	"contact_updated"	yes
`definition.trigger (shape 3).properties`	array of string	no
`definition.trigger (shape 4).kind`	"topic_subscribed"	yes
`definition.trigger (shape 4).topic_id`	string	yes	A UUID.
`definition.trigger (shape 5).kind`	"segment_entered"	yes
`definition.trigger (shape 5).segment_id`	string	yes	A UUID.
`definition.trigger (shape 6).kind`	"email_event"	yes
`definition.trigger (shape 6).type`	one of "email.sent", "email.scheduled", "email.delivered", "email.delivery_delayed", "email.complained", "email.bounced", "email.opened", "email.clicked", "email.received", "email.failed", "email.suppressed", "email.canceled", …	yes
`definition.trigger (shape 6).tag`	object	no
`definition.trigger (shape 6).tag.name`	string	yes
`definition.trigger (shape 6).tag.value`	string	yes
`definition.filter`	object or null	no	Default `null`.
`definition.filter (shape 1).all`	array of object	yes	At most 50 items.
`definition.filter (shape 1).all[].field`	string	yes	At most 120 characters.
`definition.filter (shape 1).all[].op`	one of "eq", "neq", "contains", "not_contains", "starts_with", "ends_with", "gt", "gte", "lt", "lte", "is_set", "is_not_set", …	yes
`definition.filter (shape 1).all[].value`	string or number or boolean or array of string or null	no
`definition.filter (shape 2).any`	array of object	yes	At most 50 items.
`definition.filter (shape 2).any[].field`	string	yes	At most 120 characters.
`definition.filter (shape 2).any[].op`	one of "eq", "neq", "contains", "not_contains", "starts_with", "ends_with", "gt", "gte", "lt", "lte", "is_set", "is_not_set", …	yes
`definition.filter (shape 2).any[].value`	string or number or boolean or array of string or null	no
`definition.allow_reentry`	boolean	no	Default `false`.
`definition.start`	string	yes	1 to 50 characters.
`definition.steps`	array of object	yes	At most 100 items.
`definition.steps[] (shape 1).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 1).type`	"send_email"	yes
`definition.steps[] (shape 1).template_id`	string	yes	1 to 100 characters.
`definition.steps[] (shape 1).variables`	map of string or number or boolean	no
`definition.steps[] (shape 1).from`	string	no	At most 320 characters.
`definition.steps[] (shape 1).subject`	string	no	At most 998 characters.
`definition.steps[] (shape 1).reply_to`	string	no	At most 320 characters.
`definition.steps[] (shape 1).stream`	one of "transactional", "marketing"	no
`definition.steps[] (shape 1).topic_id`	string or null	no	A UUID.
`definition.steps[] (shape 1).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 2).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 2).type`	"wait"	yes
`definition.steps[] (shape 2).duration`	object	yes
`definition.steps[] (shape 2).duration.amount`	integer	yes
`definition.steps[] (shape 2).duration.unit`	one of "minutes", "hours", "days"	yes
`definition.steps[] (shape 2).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 3).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 3).type`	"wait_for_event"	yes
`definition.steps[] (shape 3).event`	one of "email.opened", "email.clicked", "custom_event"	yes
`definition.steps[] (shape 3).custom_event`	string	no	1 to 100 characters.
`definition.steps[] (shape 3).timeout`	object	yes
`definition.steps[] (shape 3).timeout.amount`	integer	yes
`definition.steps[] (shape 3).timeout.unit`	one of "minutes", "hours", "days"	yes
`definition.steps[] (shape 3).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 3).timeout_next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 4).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 4).type`	"branch"	yes
`definition.steps[] (shape 4).condition`	object	no
`definition.steps[] (shape 4).condition (shape 1).all`	array of object	yes	At most 50 items.
`definition.steps[] (shape 4).condition (shape 2).any`	array of object	yes	At most 50 items.
`definition.steps[] (shape 4).engagement`	object	no
`definition.steps[] (shape 4).engagement.event`	one of "email.opened", "email.clicked"	yes
`definition.steps[] (shape 4).engagement.step_id`	string or null	no	1 to 50 characters. Default `null`.
`definition.steps[] (shape 4).yes`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 4).no`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 5).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 5).type`	"update_contact"	yes
`definition.steps[] (shape 5).first_name`	string or null	no	At most 200 characters.
`definition.steps[] (shape 5).last_name`	string or null	no	At most 200 characters.
`definition.steps[] (shape 5).unsubscribed`	boolean	no
`definition.steps[] (shape 5).properties`	map of string or number or boolean or null	no
`definition.steps[] (shape 5).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 6).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 6).type`	"segment"	yes
`definition.steps[] (shape 6).action`	one of "add", "remove"	yes
`definition.steps[] (shape 6).segment_id`	string	yes	A UUID.
`definition.steps[] (shape 6).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 7).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 7).type`	"topic"	yes
`definition.steps[] (shape 7).action`	one of "subscribe", "unsubscribe"	yes
`definition.steps[] (shape 7).topic_id`	string	yes	A UUID.
`definition.steps[] (shape 7).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 8).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 8).type`	"delete_contact"	yes
`definition.steps[] (shape 9).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 9).type`	"exit"	yes
`stats`	object	yes
`stats.runs_total`	integer	yes
`stats.runs_active`	integer	yes
`stats.runs_completed`	integer	yes
`stats.runs_failed`	integer	yes
`created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`updated_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X POST https://api.minket.com/v1/automations \
  -H "Authorization: Bearer $MINKET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Welcome","definition":{"trigger":{"kind":"contact_created"},"start":"wait","steps":[{"id":"wait","type":"wait","duration":{"amount":1,"unit":"days"},"next":"welcome"},{"id":"welcome","type":"send_email","template_id":"019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b","next":null}]}}'

TypeScript

const result = await minket.automations.create({
  name: "Welcome",
  definition: {
    trigger: {
      kind: "contact_created"
    },
    start: "wait",
    steps: [
      {
        id: "wait",
        type: "wait",
        duration: {
          amount: 1,
          unit: "days"
        },
        next: "welcome"
      },
      {
        id: "welcome",
        type: "send_email",
        template_id: "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b",
        next: null
      }
    ]
  }
});

CLI

minket api createAutomation --body '{"name":"Welcome","definition":{"trigger":{"kind":"contact_created"},"start":"wait","steps":[{"id":"wait","type":"wait","duration":{"amount":1,"unit":"days"},"next":"welcome"},{"id":"welcome","type":"send_email","template_id":"019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b","next":null}]}}'

Python

from minket.api.automations import create_automation
from minket.models import CreateAutomationBody

result = create_automation.sync(client=client, body=CreateAutomationBody.from_dict({"name":"Welcome","definition":{"trigger":{"kind":"contact_created"},"start":"wait","steps":[{"id":"wait","type":"wait","duration":{"amount":1,"unit":"days"},"next":"welcome"},{"id":"welcome","type":"send_email","template_id":"019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b","next":null}]}}))

var body minket.CreateAutomationJSONRequestBody
res, err := client.CreateAutomationWithResponse(ctx, body)

List automations

GET /v1/automations

Operation listAutomations, SDK minket.automations.list. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`limit`	query	integer	no	Default `20`.
`after`	query	string	no	A UUID.
`before`	query	string	no	A UUID.

Response

200 Success: object.

Field	Type	Required	Description
`object`	"list"	yes
`data`	array of object	yes
`data[].id`	string	yes	A UUID.
`data[].object`	"automation"	yes
`data[].project_id`	string	yes	A UUID.
`data[].name`	string	yes
`data[].status`	one of "draft", "active", "paused", "archived"	yes
`data[].current_version`	integer	yes
`data[].published_version`	integer or null	yes
`data[].trigger`	object	yes
`data[].trigger (shape 1).kind`	"custom_event"	yes
`data[].trigger (shape 1).event`	string	yes	1 to 100 characters.
`data[].trigger (shape 2).kind`	"contact_created"	yes
`data[].trigger (shape 3).kind`	"contact_updated"	yes
`data[].trigger (shape 3).properties`	array of string	no
`data[].trigger (shape 4).kind`	"topic_subscribed"	yes
`data[].trigger (shape 4).topic_id`	string	yes	A UUID.
`data[].trigger (shape 5).kind`	"segment_entered"	yes
`data[].trigger (shape 5).segment_id`	string	yes	A UUID.
`data[].trigger (shape 6).kind`	"email_event"	yes
`data[].trigger (shape 6).type`	one of "email.sent", "email.scheduled", "email.delivered", "email.delivery_delayed", "email.complained", "email.bounced", "email.opened", "email.clicked", "email.received", "email.failed", "email.suppressed", "email.canceled", …	yes
`data[].trigger (shape 6).tag`	object	no
`data[].trigger (shape 6).tag.name`	string	yes
`data[].trigger (shape 6).tag.value`	string	yes
`data[].stats`	object	yes
`data[].stats.runs_total`	integer	yes
`data[].stats.runs_active`	integer	yes
`data[].stats.runs_completed`	integer	yes
`data[].stats.runs_failed`	integer	yes
`data[].created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`data[].updated_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`has_more`	boolean	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/automations \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.automations.list();

CLI

minket api listAutomations

Python

from minket.api.automations import list_automations

result = list_automations.sync(client=client)

res, err := client.ListAutomationsWithResponse(ctx, &minket.ListAutomationsParams{})

Get an automation with its current definition

GET /v1/automations/{id}

Operation getAutomation, SDK minket.automations.get. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Response

200 Success: Automation.

Field	Type	Required	Description
`id`	string	yes	A UUID.
`object`	"automation"	yes
`project_id`	string	yes	A UUID.
`name`	string	yes
`status`	one of "draft", "active", "paused", "archived"	yes
`current_version`	integer	yes
`published_version`	integer or null	yes
`trigger`	object	yes
`trigger (shape 1).kind`	"custom_event"	yes
`trigger (shape 1).event`	string	yes	1 to 100 characters.
`trigger (shape 2).kind`	"contact_created"	yes
`trigger (shape 3).kind`	"contact_updated"	yes
`trigger (shape 3).properties`	array of string	no
`trigger (shape 4).kind`	"topic_subscribed"	yes
`trigger (shape 4).topic_id`	string	yes	A UUID.
`trigger (shape 5).kind`	"segment_entered"	yes
`trigger (shape 5).segment_id`	string	yes	A UUID.
`trigger (shape 6).kind`	"email_event"	yes
`trigger (shape 6).type`	one of "email.sent", "email.scheduled", "email.delivered", "email.delivery_delayed", "email.complained", "email.bounced", "email.opened", "email.clicked", "email.received", "email.failed", "email.suppressed", "email.canceled", …	yes
`trigger (shape 6).tag`	object	no
`trigger (shape 6).tag.name`	string	yes
`trigger (shape 6).tag.value`	string	yes
`definition`	object	yes
`definition.trigger`	object	yes
`definition.trigger (shape 1).kind`	"custom_event"	yes
`definition.trigger (shape 1).event`	string	yes	1 to 100 characters.
`definition.trigger (shape 2).kind`	"contact_created"	yes
`definition.trigger (shape 3).kind`	"contact_updated"	yes
`definition.trigger (shape 3).properties`	array of string	no
`definition.trigger (shape 4).kind`	"topic_subscribed"	yes
`definition.trigger (shape 4).topic_id`	string	yes	A UUID.
`definition.trigger (shape 5).kind`	"segment_entered"	yes
`definition.trigger (shape 5).segment_id`	string	yes	A UUID.
`definition.trigger (shape 6).kind`	"email_event"	yes
`definition.trigger (shape 6).type`	one of "email.sent", "email.scheduled", "email.delivered", "email.delivery_delayed", "email.complained", "email.bounced", "email.opened", "email.clicked", "email.received", "email.failed", "email.suppressed", "email.canceled", …	yes
`definition.trigger (shape 6).tag`	object	no
`definition.trigger (shape 6).tag.name`	string	yes
`definition.trigger (shape 6).tag.value`	string	yes
`definition.filter`	object or null	no	Default `null`.
`definition.filter (shape 1).all`	array of object	yes	At most 50 items.
`definition.filter (shape 1).all[].field`	string	yes	At most 120 characters.
`definition.filter (shape 1).all[].op`	one of "eq", "neq", "contains", "not_contains", "starts_with", "ends_with", "gt", "gte", "lt", "lte", "is_set", "is_not_set", …	yes
`definition.filter (shape 1).all[].value`	string or number or boolean or array of string or null	no
`definition.filter (shape 2).any`	array of object	yes	At most 50 items.
`definition.filter (shape 2).any[].field`	string	yes	At most 120 characters.
`definition.filter (shape 2).any[].op`	one of "eq", "neq", "contains", "not_contains", "starts_with", "ends_with", "gt", "gte", "lt", "lte", "is_set", "is_not_set", …	yes
`definition.filter (shape 2).any[].value`	string or number or boolean or array of string or null	no
`definition.allow_reentry`	boolean	no	Default `false`.
`definition.start`	string	yes	1 to 50 characters.
`definition.steps`	array of object	yes	At most 100 items.
`definition.steps[] (shape 1).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 1).type`	"send_email"	yes
`definition.steps[] (shape 1).template_id`	string	yes	1 to 100 characters.
`definition.steps[] (shape 1).variables`	map of string or number or boolean	no
`definition.steps[] (shape 1).from`	string	no	At most 320 characters.
`definition.steps[] (shape 1).subject`	string	no	At most 998 characters.
`definition.steps[] (shape 1).reply_to`	string	no	At most 320 characters.
`definition.steps[] (shape 1).stream`	one of "transactional", "marketing"	no
`definition.steps[] (shape 1).topic_id`	string or null	no	A UUID.
`definition.steps[] (shape 1).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 2).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 2).type`	"wait"	yes
`definition.steps[] (shape 2).duration`	object	yes
`definition.steps[] (shape 2).duration.amount`	integer	yes
`definition.steps[] (shape 2).duration.unit`	one of "minutes", "hours", "days"	yes
`definition.steps[] (shape 2).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 3).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 3).type`	"wait_for_event"	yes
`definition.steps[] (shape 3).event`	one of "email.opened", "email.clicked", "custom_event"	yes
`definition.steps[] (shape 3).custom_event`	string	no	1 to 100 characters.
`definition.steps[] (shape 3).timeout`	object	yes
`definition.steps[] (shape 3).timeout.amount`	integer	yes
`definition.steps[] (shape 3).timeout.unit`	one of "minutes", "hours", "days"	yes
`definition.steps[] (shape 3).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 3).timeout_next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 4).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 4).type`	"branch"	yes
`definition.steps[] (shape 4).condition`	object	no
`definition.steps[] (shape 4).condition (shape 1).all`	array of object	yes	At most 50 items.
`definition.steps[] (shape 4).condition (shape 2).any`	array of object	yes	At most 50 items.
`definition.steps[] (shape 4).engagement`	object	no
`definition.steps[] (shape 4).engagement.event`	one of "email.opened", "email.clicked"	yes
`definition.steps[] (shape 4).engagement.step_id`	string or null	no	1 to 50 characters. Default `null`.
`definition.steps[] (shape 4).yes`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 4).no`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 5).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 5).type`	"update_contact"	yes
`definition.steps[] (shape 5).first_name`	string or null	no	At most 200 characters.
`definition.steps[] (shape 5).last_name`	string or null	no	At most 200 characters.
`definition.steps[] (shape 5).unsubscribed`	boolean	no
`definition.steps[] (shape 5).properties`	map of string or number or boolean or null	no
`definition.steps[] (shape 5).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 6).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 6).type`	"segment"	yes
`definition.steps[] (shape 6).action`	one of "add", "remove"	yes
`definition.steps[] (shape 6).segment_id`	string	yes	A UUID.
`definition.steps[] (shape 6).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 7).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 7).type`	"topic"	yes
`definition.steps[] (shape 7).action`	one of "subscribe", "unsubscribe"	yes
`definition.steps[] (shape 7).topic_id`	string	yes	A UUID.
`definition.steps[] (shape 7).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 8).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 8).type`	"delete_contact"	yes
`definition.steps[] (shape 9).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 9).type`	"exit"	yes
`stats`	object	yes
`stats.runs_total`	integer	yes
`stats.runs_active`	integer	yes
`stats.runs_completed`	integer	yes
`stats.runs_failed`	integer	yes
`created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`updated_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/automations/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.automations.get("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api getAutomation 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.automations import get_automation

result = get_automation.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.GetAutomationWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

Update an automation

PATCH /v1/automations/{id}

Operation updateAutomation, SDK minket.automations.update. Keys: full access. Live keys only: test keys get 403 test_mode_only.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Request body

Field	Type	Required	Description
`name`	string	no	1 to 200 characters.
`definition`	object	no
`definition.trigger`	object	yes
`definition.trigger (shape 1).kind`	"custom_event"	yes
`definition.trigger (shape 1).event`	string	yes	1 to 100 characters.
`definition.trigger (shape 2).kind`	"contact_created"	yes
`definition.trigger (shape 3).kind`	"contact_updated"	yes
`definition.trigger (shape 3).properties`	array of string	no
`definition.trigger (shape 4).kind`	"topic_subscribed"	yes
`definition.trigger (shape 4).topic_id`	string	yes	A UUID.
`definition.trigger (shape 5).kind`	"segment_entered"	yes
`definition.trigger (shape 5).segment_id`	string	yes	A UUID.
`definition.trigger (shape 6).kind`	"email_event"	yes
`definition.trigger (shape 6).type`	one of "email.sent", "email.scheduled", "email.delivered", "email.delivery_delayed", "email.complained", "email.bounced", "email.opened", "email.clicked", "email.received", "email.failed", "email.suppressed", "email.canceled", …	yes
`definition.trigger (shape 6).tag`	object	no
`definition.trigger (shape 6).tag.name`	string	yes
`definition.trigger (shape 6).tag.value`	string	yes
`definition.filter`	object or null	no	Default `null`.
`definition.filter (shape 1).all`	array of object	yes	At most 50 items.
`definition.filter (shape 1).all[].field`	string	yes	At most 120 characters.
`definition.filter (shape 1).all[].op`	one of "eq", "neq", "contains", "not_contains", "starts_with", "ends_with", "gt", "gte", "lt", "lte", "is_set", "is_not_set", …	yes
`definition.filter (shape 1).all[].value`	string or number or boolean or array of string or null	no
`definition.filter (shape 2).any`	array of object	yes	At most 50 items.
`definition.filter (shape 2).any[].field`	string	yes	At most 120 characters.
`definition.filter (shape 2).any[].op`	one of "eq", "neq", "contains", "not_contains", "starts_with", "ends_with", "gt", "gte", "lt", "lte", "is_set", "is_not_set", …	yes
`definition.filter (shape 2).any[].value`	string or number or boolean or array of string or null	no
`definition.allow_reentry`	boolean	no	Default `false`.
`definition.start`	string	yes	1 to 50 characters.
`definition.steps`	array of object	yes	At most 100 items.
`definition.steps[] (shape 1).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 1).type`	"send_email"	yes
`definition.steps[] (shape 1).template_id`	string	yes	1 to 100 characters.
`definition.steps[] (shape 1).variables`	map of string or number or boolean	no
`definition.steps[] (shape 1).from`	string	no	At most 320 characters.
`definition.steps[] (shape 1).subject`	string	no	At most 998 characters.
`definition.steps[] (shape 1).reply_to`	string	no	At most 320 characters.
`definition.steps[] (shape 1).stream`	one of "transactional", "marketing"	no
`definition.steps[] (shape 1).topic_id`	string or null	no	A UUID.
`definition.steps[] (shape 1).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 2).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 2).type`	"wait"	yes
`definition.steps[] (shape 2).duration`	object	yes
`definition.steps[] (shape 2).duration.amount`	integer	yes
`definition.steps[] (shape 2).duration.unit`	one of "minutes", "hours", "days"	yes
`definition.steps[] (shape 2).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 3).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 3).type`	"wait_for_event"	yes
`definition.steps[] (shape 3).event`	one of "email.opened", "email.clicked", "custom_event"	yes
`definition.steps[] (shape 3).custom_event`	string	no	1 to 100 characters.
`definition.steps[] (shape 3).timeout`	object	yes
`definition.steps[] (shape 3).timeout.amount`	integer	yes
`definition.steps[] (shape 3).timeout.unit`	one of "minutes", "hours", "days"	yes
`definition.steps[] (shape 3).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 3).timeout_next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 4).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 4).type`	"branch"	yes
`definition.steps[] (shape 4).condition`	object	no
`definition.steps[] (shape 4).condition (shape 1).all`	array of object	yes	At most 50 items.
`definition.steps[] (shape 4).condition (shape 2).any`	array of object	yes	At most 50 items.
`definition.steps[] (shape 4).engagement`	object	no
`definition.steps[] (shape 4).engagement.event`	one of "email.opened", "email.clicked"	yes
`definition.steps[] (shape 4).engagement.step_id`	string or null	no	1 to 50 characters. Default `null`.
`definition.steps[] (shape 4).yes`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 4).no`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 5).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 5).type`	"update_contact"	yes
`definition.steps[] (shape 5).first_name`	string or null	no	At most 200 characters.
`definition.steps[] (shape 5).last_name`	string or null	no	At most 200 characters.
`definition.steps[] (shape 5).unsubscribed`	boolean	no
`definition.steps[] (shape 5).properties`	map of string or number or boolean or null	no
`definition.steps[] (shape 5).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 6).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 6).type`	"segment"	yes
`definition.steps[] (shape 6).action`	one of "add", "remove"	yes
`definition.steps[] (shape 6).segment_id`	string	yes	A UUID.
`definition.steps[] (shape 6).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 7).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 7).type`	"topic"	yes
`definition.steps[] (shape 7).action`	one of "subscribe", "unsubscribe"	yes
`definition.steps[] (shape 7).topic_id`	string	yes	A UUID.
`definition.steps[] (shape 7).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 8).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 8).type`	"delete_contact"	yes
`definition.steps[] (shape 9).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 9).type`	"exit"	yes
`status`	one of "active", "paused", "archived"	no

Response

200 Success: object.

Field	Type	Required	Description
`object`	"automation"	yes
`id`	string	yes	A UUID.
`status`	one of "draft", "active", "paused", "archived"	yes
`current_version`	integer	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X PATCH https://api.minket.com/v1/automations/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b \
  -H "Authorization: Bearer $MINKET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"paused"}'

TypeScript

const result = await minket.automations.update("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", {
  status: "paused"
});

CLI

minket api updateAutomation 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b --body '{"status":"paused"}'

Python

from minket.api.automations import update_automation
from minket.models import UpdateAutomationBody

result = update_automation.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client, body=UpdateAutomationBody.from_dict({"status":"paused"}))

var body minket.UpdateAutomationJSONRequestBody
res, err := client.UpdateAutomationWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", body)

Archive an automation

DELETE /v1/automations/{id}

Operation deleteAutomation, SDK minket.automations.delete. Keys: full access. Live keys only: test keys get 403 test_mode_only.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Response

200 Success: object.

Field	Type	Required	Description
`object`	"automation"	yes
`id`	string	yes	A UUID.
`status`	one of "draft", "active", "paused", "archived"	yes
`current_version`	integer	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X DELETE https://api.minket.com/v1/automations/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.automations.delete("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api deleteAutomation 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.automations import delete_automation

result = delete_automation.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.DeleteAutomationWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

Publish the current version

POST /v1/automations/{id}/publish

New runs start on this version; in-flight runs finish on theirs.

Operation publishAutomation, SDK minket.automations.publish. Keys: full access. Live keys only: test keys get 403 test_mode_only.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Response

200 Success: object.

Field	Type	Required	Description
`object`	"automation"	yes
`id`	string	yes	A UUID.
`status`	one of "draft", "active", "paused", "archived"	yes
`current_version`	integer	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X POST https://api.minket.com/v1/automations/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/publish \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.automations.publish("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api publishAutomation 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.automations import publish_automation

result = publish_automation.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.PublishAutomationWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

Pause an automation and stop its waiting runs

POST /v1/automations/{id}/stop

Operation stopAutomation, SDK minket.automations.stop. Keys: full access. Live keys only: test keys get 403 test_mode_only.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Response

200 Success: object.

Field	Type	Required	Description
`object`	"automation"	yes
`id`	string	yes	A UUID.
`status`	one of "draft", "active", "paused", "archived"	yes
`current_version`	integer	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X POST https://api.minket.com/v1/automations/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/stop \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.automations.stop("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api stopAutomation 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.automations import stop_automation

result = stop_automation.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.StopAutomationWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

Duplicate an automation

POST /v1/automations/{id}/duplicate

A new draft named <name> (copy) with the current version's definition (the newest draft, if it is newer than the published version). It starts no runs until it is published.

Operation duplicateAutomation, SDK minket.automations.duplicate. Keys: full access. Live keys only: test keys get 403 test_mode_only.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Response

201 Created: Automation.

Field	Type	Required	Description
`id`	string	yes	A UUID.
`object`	"automation"	yes
`project_id`	string	yes	A UUID.
`name`	string	yes
`status`	one of "draft", "active", "paused", "archived"	yes
`current_version`	integer	yes
`published_version`	integer or null	yes
`trigger`	object	yes
`trigger (shape 1).kind`	"custom_event"	yes
`trigger (shape 1).event`	string	yes	1 to 100 characters.
`trigger (shape 2).kind`	"contact_created"	yes
`trigger (shape 3).kind`	"contact_updated"	yes
`trigger (shape 3).properties`	array of string	no
`trigger (shape 4).kind`	"topic_subscribed"	yes
`trigger (shape 4).topic_id`	string	yes	A UUID.
`trigger (shape 5).kind`	"segment_entered"	yes
`trigger (shape 5).segment_id`	string	yes	A UUID.
`trigger (shape 6).kind`	"email_event"	yes
`trigger (shape 6).type`	one of "email.sent", "email.scheduled", "email.delivered", "email.delivery_delayed", "email.complained", "email.bounced", "email.opened", "email.clicked", "email.received", "email.failed", "email.suppressed", "email.canceled", …	yes
`trigger (shape 6).tag`	object	no
`trigger (shape 6).tag.name`	string	yes
`trigger (shape 6).tag.value`	string	yes
`definition`	object	yes
`definition.trigger`	object	yes
`definition.trigger (shape 1).kind`	"custom_event"	yes
`definition.trigger (shape 1).event`	string	yes	1 to 100 characters.
`definition.trigger (shape 2).kind`	"contact_created"	yes
`definition.trigger (shape 3).kind`	"contact_updated"	yes
`definition.trigger (shape 3).properties`	array of string	no
`definition.trigger (shape 4).kind`	"topic_subscribed"	yes
`definition.trigger (shape 4).topic_id`	string	yes	A UUID.
`definition.trigger (shape 5).kind`	"segment_entered"	yes
`definition.trigger (shape 5).segment_id`	string	yes	A UUID.
`definition.trigger (shape 6).kind`	"email_event"	yes
`definition.trigger (shape 6).type`	one of "email.sent", "email.scheduled", "email.delivered", "email.delivery_delayed", "email.complained", "email.bounced", "email.opened", "email.clicked", "email.received", "email.failed", "email.suppressed", "email.canceled", …	yes
`definition.trigger (shape 6).tag`	object	no
`definition.trigger (shape 6).tag.name`	string	yes
`definition.trigger (shape 6).tag.value`	string	yes
`definition.filter`	object or null	no	Default `null`.
`definition.filter (shape 1).all`	array of object	yes	At most 50 items.
`definition.filter (shape 1).all[].field`	string	yes	At most 120 characters.
`definition.filter (shape 1).all[].op`	one of "eq", "neq", "contains", "not_contains", "starts_with", "ends_with", "gt", "gte", "lt", "lte", "is_set", "is_not_set", …	yes
`definition.filter (shape 1).all[].value`	string or number or boolean or array of string or null	no
`definition.filter (shape 2).any`	array of object	yes	At most 50 items.
`definition.filter (shape 2).any[].field`	string	yes	At most 120 characters.
`definition.filter (shape 2).any[].op`	one of "eq", "neq", "contains", "not_contains", "starts_with", "ends_with", "gt", "gte", "lt", "lte", "is_set", "is_not_set", …	yes
`definition.filter (shape 2).any[].value`	string or number or boolean or array of string or null	no
`definition.allow_reentry`	boolean	no	Default `false`.
`definition.start`	string	yes	1 to 50 characters.
`definition.steps`	array of object	yes	At most 100 items.
`definition.steps[] (shape 1).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 1).type`	"send_email"	yes
`definition.steps[] (shape 1).template_id`	string	yes	1 to 100 characters.
`definition.steps[] (shape 1).variables`	map of string or number or boolean	no
`definition.steps[] (shape 1).from`	string	no	At most 320 characters.
`definition.steps[] (shape 1).subject`	string	no	At most 998 characters.
`definition.steps[] (shape 1).reply_to`	string	no	At most 320 characters.
`definition.steps[] (shape 1).stream`	one of "transactional", "marketing"	no
`definition.steps[] (shape 1).topic_id`	string or null	no	A UUID.
`definition.steps[] (shape 1).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 2).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 2).type`	"wait"	yes
`definition.steps[] (shape 2).duration`	object	yes
`definition.steps[] (shape 2).duration.amount`	integer	yes
`definition.steps[] (shape 2).duration.unit`	one of "minutes", "hours", "days"	yes
`definition.steps[] (shape 2).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 3).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 3).type`	"wait_for_event"	yes
`definition.steps[] (shape 3).event`	one of "email.opened", "email.clicked", "custom_event"	yes
`definition.steps[] (shape 3).custom_event`	string	no	1 to 100 characters.
`definition.steps[] (shape 3).timeout`	object	yes
`definition.steps[] (shape 3).timeout.amount`	integer	yes
`definition.steps[] (shape 3).timeout.unit`	one of "minutes", "hours", "days"	yes
`definition.steps[] (shape 3).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 3).timeout_next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 4).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 4).type`	"branch"	yes
`definition.steps[] (shape 4).condition`	object	no
`definition.steps[] (shape 4).condition (shape 1).all`	array of object	yes	At most 50 items.
`definition.steps[] (shape 4).condition (shape 2).any`	array of object	yes	At most 50 items.
`definition.steps[] (shape 4).engagement`	object	no
`definition.steps[] (shape 4).engagement.event`	one of "email.opened", "email.clicked"	yes
`definition.steps[] (shape 4).engagement.step_id`	string or null	no	1 to 50 characters. Default `null`.
`definition.steps[] (shape 4).yes`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 4).no`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 5).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 5).type`	"update_contact"	yes
`definition.steps[] (shape 5).first_name`	string or null	no	At most 200 characters.
`definition.steps[] (shape 5).last_name`	string or null	no	At most 200 characters.
`definition.steps[] (shape 5).unsubscribed`	boolean	no
`definition.steps[] (shape 5).properties`	map of string or number or boolean or null	no
`definition.steps[] (shape 5).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 6).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 6).type`	"segment"	yes
`definition.steps[] (shape 6).action`	one of "add", "remove"	yes
`definition.steps[] (shape 6).segment_id`	string	yes	A UUID.
`definition.steps[] (shape 6).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 7).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 7).type`	"topic"	yes
`definition.steps[] (shape 7).action`	one of "subscribe", "unsubscribe"	yes
`definition.steps[] (shape 7).topic_id`	string	yes	A UUID.
`definition.steps[] (shape 7).next`	string or null	yes	1 to 50 characters.
`definition.steps[] (shape 8).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 8).type`	"delete_contact"	yes
`definition.steps[] (shape 9).id`	string	yes	1 to 50 characters.
`definition.steps[] (shape 9).type`	"exit"	yes
`stats`	object	yes
`stats.runs_total`	integer	yes
`stats.runs_active`	integer	yes
`stats.runs_completed`	integer	yes
`stats.runs_failed`	integer	yes
`created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`updated_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl -X POST https://api.minket.com/v1/automations/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/duplicate \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.automations.duplicate("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api duplicateAutomation 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.automations import duplicate_automation

result = duplicate_automation.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.DuplicateAutomationWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

List versions

GET /v1/automations/{id}/versions

Operation listAutomationVersions, SDK minket.automations.versions. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.

Response

200 Success: object.

Field	Type	Required	Description
`object`	"list"	yes
`data`	array of object	yes
`data[].version`	integer	yes
`data[].definition`	object	yes
`data[].definition.trigger`	object	yes
`data[].definition.trigger (shape 1).kind`	"custom_event"	yes
`data[].definition.trigger (shape 1).event`	string	yes	1 to 100 characters.
`data[].definition.trigger (shape 2).kind`	"contact_created"	yes
`data[].definition.trigger (shape 3).kind`	"contact_updated"	yes
`data[].definition.trigger (shape 3).properties`	array of string	no
`data[].definition.trigger (shape 4).kind`	"topic_subscribed"	yes
`data[].definition.trigger (shape 4).topic_id`	string	yes	A UUID.
`data[].definition.trigger (shape 5).kind`	"segment_entered"	yes
`data[].definition.trigger (shape 5).segment_id`	string	yes	A UUID.
`data[].definition.trigger (shape 6).kind`	"email_event"	yes
`data[].definition.trigger (shape 6).type`	one of "email.sent", "email.scheduled", "email.delivered", "email.delivery_delayed", "email.complained", "email.bounced", "email.opened", "email.clicked", "email.received", "email.failed", "email.suppressed", "email.canceled", …	yes
`data[].definition.trigger (shape 6).tag`	object	no
`data[].definition.filter`	object or null	no	Default `null`.
`data[].definition.filter (shape 1).all`	array of object	yes	At most 50 items.
`data[].definition.filter (shape 2).any`	array of object	yes	At most 50 items.
`data[].definition.allow_reentry`	boolean	no	Default `false`.
`data[].definition.start`	string	yes	1 to 50 characters.
`data[].definition.steps`	array of object	yes	At most 100 items.
`data[].definition.steps[] (shape 1).id`	string	yes	1 to 50 characters.
`data[].definition.steps[] (shape 1).type`	"send_email"	yes
`data[].definition.steps[] (shape 1).template_id`	string	yes	1 to 100 characters.
`data[].definition.steps[] (shape 1).variables`	map of string or number or boolean	no
`data[].definition.steps[] (shape 1).from`	string	no	At most 320 characters.
`data[].definition.steps[] (shape 1).subject`	string	no	At most 998 characters.
`data[].definition.steps[] (shape 1).reply_to`	string	no	At most 320 characters.
`data[].definition.steps[] (shape 1).stream`	one of "transactional", "marketing"	no
`data[].definition.steps[] (shape 1).topic_id`	string or null	no	A UUID.
`data[].definition.steps[] (shape 1).next`	string or null	yes	1 to 50 characters.
`data[].definition.steps[] (shape 2).id`	string	yes	1 to 50 characters.
`data[].definition.steps[] (shape 2).type`	"wait"	yes
`data[].definition.steps[] (shape 2).duration`	object	yes
`data[].definition.steps[] (shape 2).next`	string or null	yes	1 to 50 characters.
`data[].definition.steps[] (shape 3).id`	string	yes	1 to 50 characters.
`data[].definition.steps[] (shape 3).type`	"wait_for_event"	yes
`data[].definition.steps[] (shape 3).event`	one of "email.opened", "email.clicked", "custom_event"	yes
`data[].definition.steps[] (shape 3).custom_event`	string	no	1 to 100 characters.
`data[].definition.steps[] (shape 3).timeout`	object	yes
`data[].definition.steps[] (shape 3).next`	string or null	yes	1 to 50 characters.
`data[].definition.steps[] (shape 3).timeout_next`	string or null	yes	1 to 50 characters.
`data[].definition.steps[] (shape 4).id`	string	yes	1 to 50 characters.
`data[].definition.steps[] (shape 4).type`	"branch"	yes
`data[].definition.steps[] (shape 4).condition`	object	no
`data[].definition.steps[] (shape 4).engagement`	object	no
`data[].definition.steps[] (shape 4).yes`	string or null	yes	1 to 50 characters.
`data[].definition.steps[] (shape 4).no`	string or null	yes	1 to 50 characters.
`data[].definition.steps[] (shape 5).id`	string	yes	1 to 50 characters.
`data[].definition.steps[] (shape 5).type`	"update_contact"	yes
`data[].definition.steps[] (shape 5).first_name`	string or null	no	At most 200 characters.
`data[].definition.steps[] (shape 5).last_name`	string or null	no	At most 200 characters.
`data[].definition.steps[] (shape 5).unsubscribed`	boolean	no
`data[].definition.steps[] (shape 5).properties`	map of string or number or boolean or null	no
`data[].definition.steps[] (shape 5).next`	string or null	yes	1 to 50 characters.
`data[].definition.steps[] (shape 6).id`	string	yes	1 to 50 characters.
`data[].definition.steps[] (shape 6).type`	"segment"	yes
`data[].definition.steps[] (shape 6).action`	one of "add", "remove"	yes
`data[].definition.steps[] (shape 6).segment_id`	string	yes	A UUID.
`data[].definition.steps[] (shape 6).next`	string or null	yes	1 to 50 characters.
`data[].definition.steps[] (shape 7).id`	string	yes	1 to 50 characters.
`data[].definition.steps[] (shape 7).type`	"topic"	yes
`data[].definition.steps[] (shape 7).action`	one of "subscribe", "unsubscribe"	yes
`data[].definition.steps[] (shape 7).topic_id`	string	yes	A UUID.
`data[].definition.steps[] (shape 7).next`	string or null	yes	1 to 50 characters.
`data[].definition.steps[] (shape 8).id`	string	yes	1 to 50 characters.
`data[].definition.steps[] (shape 8).type`	"delete_contact"	yes
`data[].definition.steps[] (shape 9).id`	string	yes	1 to 50 characters.
`data[].definition.steps[] (shape 9).type`	"exit"	yes
`data[].published_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`data[].created_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`has_more`	boolean	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/automations/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/versions \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.automations.versions("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api listAutomationVersions 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.automations import list_automation_versions

result = list_automation_versions.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.ListAutomationVersionsWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

List runs

GET /v1/automations/{id}/runs

Operation listAutomationRuns, SDK minket.automations.runs. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.
`limit`	query	integer	no	Default `20`.
`after`	query	string	no	A UUID.
`before`	query	string	no	A UUID.
`status`	query	one of "running", "waiting", "completed", "exited", "failed", "stopped"	no
`contact_id`	query	string	no	A UUID.

Response

200 Success: object.

Field	Type	Required	Description
`object`	"list"	yes
`data`	array of object	yes
`data[].id`	string	yes	A UUID.
`data[].object`	"run"	yes
`data[].automation_id`	string	yes	A UUID.
`data[].version`	integer	yes
`data[].contact_id`	string or null	yes	A UUID.
`data[].trigger_event_id`	string or null	yes	A UUID.
`data[].mode`	one of "live", "test"	yes
`data[].status`	one of "running", "waiting", "completed", "exited", "failed", "stopped"	yes
`data[].current_step_id`	string or null	yes
`data[].wait_until`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`data[].error`	string or null	yes
`data[].started_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`data[].finished_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`has_more`	boolean	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/automations/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/runs \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.automations.runs("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api listAutomationRuns 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.automations import list_automation_runs

result = list_automation_runs.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.ListAutomationRunsWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", &minket.ListAutomationRunsParams{})

Get a run with its step history

GET /v1/automations/{id}/runs/{runId}

Operation getAutomationRun, SDK minket.automations.run. Keys: full access. Test keys work on test-mode data.

Parameters

Name	In	Type	Required	Description
`id`	path	string	yes	A UUID.
`runId`	path	string	yes	A UUID.

Response

200 Success: AutomationRun.

Field	Type	Required	Description
`id`	string	yes	A UUID.
`object`	"run"	yes
`automation_id`	string	yes	A UUID.
`version`	integer	yes
`contact_id`	string or null	yes	A UUID.
`trigger_event_id`	string or null	yes	A UUID.
`mode`	one of "live", "test"	yes
`status`	one of "running", "waiting", "completed", "exited", "failed", "stopped"	yes
`current_step_id`	string or null	yes
`wait_until`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`error`	string or null	yes
`steps`	array of object	yes
`steps[].step_id`	string	yes
`steps[].type`	string	yes
`steps[].status`	one of "running", "waiting", "completed", "skipped", "failed"	yes
`steps[].started_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`steps[].finished_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`steps[].output`	map of any or null	yes
`steps[].error`	string or null	yes
`started_at`	string (date-time)	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.
`finished_at`	string (date-time) or null	yes	An ISO 8601 timestamp with timezone, for example 2026-10-24T18:00:00.000Z.

Errors: 400, 401, 403, 404, 409, 422, 429, 500, with the error body.

Examples

curl

curl https://api.minket.com/v1/automations/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b/runs/019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b \
  -H "Authorization: Bearer $MINKET_API_KEY"

TypeScript

const result = await minket.automations.run("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b");

CLI

minket api getAutomationRun 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b

Python

from minket.api.automations import get_automation_run

result = get_automation_run.sync("019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", client=client)

res, err := client.GetAutomationRunWithResponse(ctx, "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b", "019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b")

Updated 30 October 2026