Automations

Get an automation

Returns one automation from the authenticated workspace.

get/v1/automations/{automation_id}

Request

Base URL: https://api.mailrith.com
URL: https://api.mailrith.com/v1/automations/{automation_id}
Auth: HTTP bearer

Path parameters

automation_idstring required

The automation identifier.

Response

Successful response

Example response

{
  "data": {
    "definition": {
      "version": 2,
      "trigger": {
        "type": "tag_added",
        "tagIds": [
          "tag_welcome"
        ]
      },
      "steps": [
        {
          "id": "send-welcome-email",
          "kind": "action",
          "type": "send_email",
          "config": {
            "subject": "Welcome",
            "previewText": "Thanks for joining",
            "bodyDocument": {
              "type": "doc",
              "content": [
                {
                  "type": "paragraph",
                  "content": [
                    {
                      "type": "text",
                      "text": "Welcome to Mailrith."
                    }
                  ]
                }
              ]
            },
            "replyToEmail": "",
            "trackOpens": true,
            "trackClicks": true,
            "utmSource": "",
            "utmMedium": "",
            "utmCampaign": "",
            "utmTerm": "",
            "utmContent": ""
          }
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.