Automations

The Automation object is used to represent an automation, workflow or custom event in the remote system.

The Automation object

Properties

actionsArray
Required
The actions performed by this automation.
nameString
Optional
The automation's name.
trigger_typeEnum
Optional
The trigger type for running this automation. Possible values include: TRIGGER_EVENT, RECURRENCE, or - in cases where there is no clear mapping - the original value passed through.
start_dateString
Optional
The automation's start date.
end_dateString
Optional
The automation's end date.
descriptionString
Optional
The automation’s description.
statusString
Optional
The automation's status.
automation_triggerObject
Optional
The trigger configuraton for the automation.
idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
The Automation object
JSON
{
  "name": "Welcome Email",
  "trigger_type": "RECURRENCE",
  "start_date": "2022-12-23T00:00:00Z",
  "end_date": "2022-12-23T00:00:00Z",
  "description": "This sends a welcome email to new customers.",
  "status": "Published",
  "automation_trigger": {
    "recurrence_schedule": {
      "days": [
        "Sunday"
      ],
      "hours": {
        "type": "send_asap"
      }
    },
    "trigger_settings": {
      "trigger_event": "NEW_CUSTOMER"
    }
  },
  "actions": [
    "52ce940b-ecfe-43a6-955f-629f799f7f73"
  ],
  "id": "45ce474c-dhcj-43a6-754r-629f799f7d68",
  "remote_id": "12"
}
GET

/automations

Returns a list of Automation objects.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters

created_afterString
Optional
If provided, will only return objects created after this datetime.
created_beforeString
Optional
If provided, will only return objects created before this datetime.
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterString
Optional
If provided, will only return objects modified after this datetime.
modified_beforeString
Optional
If provided, will only return objects modified before this datetime.
page_sizeInteger
Optional
Number of results to return per page.
remote_idString
Optional
The API provider's ID for the given object.
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "name": "Welcome Email",
      "trigger_type": "RECURRENCE",
      "start_date": "2022-12-23T00:00:00Z",
      "end_date": "2022-12-23T00:00:00Z",
      "description": "This sends a welcome email to new customers.",
      "status": "Published",
      "automation_trigger": {
        "recurrence_schedule": {
          "days": [
            "Sunday"
          ],
          "hours": {
            "type": "send_asap"
          }
        },
        "trigger_settings": {
          "trigger_event": "NEW_CUSTOMER"
        }
      },
      "actions": [
        "52ce940b-ecfe-43a6-955f-629f799f7f73"
      ],
      "id": "45ce474c-dhcj-43a6-754r-629f799f7d68",
      "remote_id": "12"
    }
  ]
}
POST

/automations

Creates an Automation object with the given values.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters

is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.
run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.

Body Parameters

modelObject
Required
Find available fields below under “Model Parameters”.

Model Parameters

View app-specific writable fields under “Field support by platform” in this section.
nameString
The automation's name.
trigger_typeEnum
The trigger type for running this automation. Must pass in one of the following choices: TRIGGER_EVENT, RECURRENCE.
start_dateString
The automation's start date.
end_dateString
The automation's end date.
descriptionString
The automation’s description.
statusString
The automation's status.
automation_triggerObject
The trigger configuraton for the automation.
actionsArray
The actions performed by this automation.
integration_paramsObject
linked_account_paramsObject
POST v1/automations
JSON
{
  "model": {
    "name": "Welcome Email",
    "trigger_type": "RECURRENCE",
    "start_date": "2022-12-23T00:00:00Z",
    "end_date": "2022-12-23T00:00:00Z",
    "description": "This sends a welcome email to new customers.",
    "status": "Published",
    "automation_trigger": {
      "recurrence_schedule": {
        "days": [
          "Sunday"
        ],
        "hours": {
          "type": "send_asap"
        }
      },
      "trigger_settings": {
        "trigger_event": "NEW_CUSTOMER"
      }
    },
    "actions": [
      "52ce940b-ecfe-43a6-955f-629f799f7f73"
    ]
  }
}
Response
JSON
{
  "model": {
    "name": "Welcome Email",
    "trigger_type": "RECURRENCE",
    "start_date": "2022-12-23T00:00:00Z",
    "end_date": "2022-12-23T00:00:00Z",
    "description": "This sends a welcome email to new customers.",
    "status": "Published",
    "automation_trigger": {
      "recurrence_schedule": {
        "days": [
          "Sunday"
        ],
        "hours": {
          "type": "send_asap"
        }
      },
      "trigger_settings": {
        "trigger_event": "NEW_CUSTOMER"
      }
    },
    "actions": [
      "52ce940b-ecfe-43a6-955f-629f799f7f73"
    ],
    "id": "45ce474c-dhcj-43a6-754r-629f799f7d68",
    "remote_id": "12"
  },
  "warnings": [
    {
      "source": {
        "pointer": "/age"
      },
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD"
    }
  ],
  "errors": [
    {
      "source": {
        "pointer": "/model/custom_fields"
      },
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD"
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "https://harvest.greenhouse.io/v1/candidates/",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}
GET

/automations/{id}

Returns an Automation object with the given id.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters

idString
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
  "name": "Welcome Email",
  "trigger_type": "RECURRENCE",
  "start_date": "2022-12-23T00:00:00Z",
  "end_date": "2022-12-23T00:00:00Z",
  "description": "This sends a welcome email to new customers.",
  "status": "Published",
  "automation_trigger": {
    "recurrence_schedule": {
      "days": [
        "Sunday"
      ],
      "hours": {
        "type": "send_asap"
      }
    },
    "trigger_settings": {
      "trigger_event": "NEW_CUSTOMER"
    }
  },
  "actions": [
    "52ce940b-ecfe-43a6-955f-629f799f7f73"
  ],
  "id": "45ce474c-dhcj-43a6-754r-629f799f7d68",
  "remote_id": "12"
}
GET

/automations/{parent_id}/recipients

Returns a list of Contact objects.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters

cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
page_sizeInteger
Optional
Number of results to return per page.
parent_idString
Required
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "first_name": "Gil",
      "last_name": "Feig",
      "email": "[email protected]",
      "phone": "+13785579223",
      "state": "NY",
      "country": "USA",
      "postal_code": "string",
      "remote_created_at": "2022-12-23T00:00:00Z",
      "remote_updated_at": "2022-12-23T00:00:00Z",
      "id": "5858cbc6-6040-430a-475r-aafacbadrg64",
      "remote_id": "35"
    }
  ]
}
GET

/automations/meta/post

Returns metadata for MKTGAutomation POSTs.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
Response
JSON
{
  "request_schema": {},
  "remote_field_classes": {},
  "status": {
    "linked_account_status": "string",
    "can_make_request": true
  },
  "has_conditional_params": true,
  "has_required_linked_account_params": true
}

Previous

Actions

Next Up

Campaigns