Mailmus

Automations

GET
/apps/{appId}/automations
AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Response Body

curl -X GET "https://example.com/apps/string/automations"
Empty
POST
/apps/{appId}/automations
AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/automations" \  -H "Content-Type: application/json" \  -d '{    "name": "Welcome sequence",    "trigger": {      "type": "AUDIENCE_JOINED",      "audienceId": "aud_abc123"    },    "steps": [      {        "type": "SEND_EMAIL",        "templateId": "tpl_abc123",        "domainId": "dom_abc123",        "fromEmail": "hello@yourdomain.com",        "subject": "Welcome!"      }    ]  }'
Empty
PATCH
/apps/{appId}/automations/{id}
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PATCH "https://example.com/apps/string/automations/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty
DELETE
/apps/{appId}/automations/{id}
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X DELETE "https://example.com/apps/string/automations/string"
Empty
PATCH
/apps/{appId}/automations/{id}/active
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X PATCH "https://example.com/apps/string/automations/string/active"
Empty
GET
/apps/{appId}/automations/{id}/runs
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X GET "https://example.com/apps/string/automations/string/runs"
Empty