Automations

Create a automation

Either provide trigger directly, or basedOn to duplicate an existing automation. The automation always starts in "draft" status - use POST .../automations/{id}/activate once its trigger and sequence are ready.

post/v1/projectId/{projectId}/automations

Request

  • Base URL: https://api.bluefox.email
  • URL: https://api.bluefox.email/v1/projectId/{projectId}/automations
  • Auth: HTTP bearer

Path parameters

projectIdstring required

The project _id, found in the app under Project Settings.

Request body

namestring required
triggerobject

Required on create unless basedOn is given. Shape depends on type - see the Automations guide.

exitCriteriaobject
basedOnstring

Duplicate an existing automation (by _id) as the starting point - copies its sequence, trigger, and exit criteria. The new automation is always created in "draft" status regardless of the source's status.

subscriberListIdstring

With basedOn, overrides the duplicated trigger's subscriberListId - lets you clone an automation onto a different list.

Response

Created

statusinteger

Example response

{
  "status": 200
}

Changes

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