Enrol a automation

POST/api/v1/automations/{automation}/enrol

Requires anorganization API keywith the scopeautomations:write

Parameters

Name	In	Type	Description
`automation`required	path	string	The automation identifier.

Request body

contact_idstring
emailstring

Request

POST/api/v1/automations/{automation}/enrol

curl -X POST 'https://app.mailyte.com/api/v1/automations/01JBT8XQ2M9WYC3K4F6R7S8T9V/enrol' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "contact_id": "<string>",
    "email": "<string>"
  }'

const response = await fetch('https://app.mailyte.com/api/v1/automations/01JBT8XQ2M9WYC3K4F6R7S8T9V/enrol', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "contact_id": "<string>",
    "email": "<string>"
  }),
});
const { data } = await response.json();

import requests
response = requests.post(
    "https://app.mailyte.com/api/v1/automations/01JBT8XQ2M9WYC3K4F6R7S8T9V/enrol",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
    json={
      "contact_id": "<string>",
      "email": "<string>"
    },
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->post('https://app.mailyte.com/api/v1/automations/01JBT8XQ2M9WYC3K4F6R7S8T9V/enrol', [
    'contact_id' => '<string>',
    'email' => '<string>',
]);

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/automations/01JBT8XQ2M9WYC3K4F6R7S8T9V/enrol")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
request["Content-Type"] = "application/json"
request.body = {
  "contact_id": "<string>",
  "email": "<string>"
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

dataobject
- idstring
- automation_idstring
- version_idstring
  The version this run entered. It finishes that version even if a newer one is published.
- version_numberinteger
- contactobject
  - idstring
  - emailstring
  - namestring
- statestringenrolled | running | waiting_time | waiting_event | paused | completed | exited | failed
- current_node_idstring
- wake_atstring
  When the engine next picks this run up. UTC.
- waiting_eventstring
- entered_atstring
- ended_atstring
- exit_reasonstring
  Why the run ended early: event:<name>, unsubscribed, archived, goal:<node>.
- errorstring
- contextobject
  The trigger payload: the event properties, or the list or tag that started the run.
- automationobject
  Present on a contact's run list.
  - idstring
  - namestring
  - statestring
- summarystring
  One plain-language line about this run. Present on a contact's run list.
- stepsarray<object>
  Present when a single run is fetched; omitted from the list.
  - idinteger
  - node_idstring
    The node in the version graph this step belongs to.
  - node_typestring
    The node type, e.g. delay, send_email, trigger, exit_rule.
  - occurred_atstring
  - outcomestringenrolled | executed | sending | sent | skipped | deferred | branch | exited | failed | unknown
  - branch_takenstring
  - message_idstring
    The sent message, when this step sent one. Ties the step to delivery events.
  - skipped_reasonstring
    Why nothing was sent: suppressed, unsubscribed, marketing_review_pending, rate_limited, not_mailable.
  - detailsobject
- narrativeobject
  Present when a single run is fetched: the steps as sentences, in the contact's local time.
  - timezonestring
  - tz_sourcestringcontact | organization_default | utc
    Where the timezone came from: the contact's own attribute, the organisation default, or UTC.
  - paragraphsarray<string>
    One paragraph per local day, plus what never happened after an early exit.
  - linesarray<object>
    - node_idstring
    - atstring
    - textstring
    - outcomestring
    - ghostboolean
      True for a step that never ran because the run ended early.

Returned inside the standard envelope.

Errors

Status	When
`401`	The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
`403`	The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys.
`404`	No such resource in this organization.
`422`	The request was understood but the values were not acceptable.
`429`	Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait.

Every status, with what causes it and what to do, is on the error reference.