The API reference moved here from eksis.io/developers.
Automations

Update an automation

PATCH
/v1/automations/{automationId}

Changes only the fields you send. postLinks replaces the posts watched and actions the whole action list. Changes to an active automation apply from the next comment or DM. Needs the admin role.

Authorization

headerAuthorizationBearer <token>

Send your key as Authorization: Bearer eksis_sk_....

Path Parameters

automationId*string

Request Body

application/json
  1. body
name?string

The name in the automation list.

Length1 <= length <= 80
status?string

draft saves it without running it. active starts replying and sending DMs in the workspace's name right away. paused keeps it off.

Value in"active""paused""draft"
trigger?string

What starts it: any comment or a comment with a keyword on a watched post, any DM or a DM with a keyword, or a reply to a Story.

Value in"comment_created""comment_keyword""dm_received""dm_keyword""story_reply"
channelIds?array<string>

Channel ids from GET /v1/channels the automation runs on.

Items1 <= items <= 50
postLinks?array<>

Links to posts already live on those channels, as the address bar shows them. Comment triggers only. Sending it replaces the posts watched. A workspace can look up 10 post links a minute.

Itemsitems <= 5
keywords?array<>

Words that start the automation. An empty list removes the keyword rule.

Itemsitems <= 30
keywordMode?string

How a keyword matches the comment or message. contains when left out.

Value in"contains""exact""starts_with"
excludeKeywords?array<>

Words that stop it even when a keyword matches. An empty list removes the rule.

Itemsitems <= 30
contactKind?string

new acts only on people eksis has not seen before, returning only on people it has.

Value in"any""new""returning"
actions?array<||||||||>

What happens, in order. Sending it replaces the whole list.

Items1 <= items <= 10
guardrails?

Response Body

The automation.

application/json
  1. response
data?
curl -X PATCH 'https://api.eksis.io/v1/automations/string' \  -H 'Authorization: Bearer eksis_sk_...' \  -H 'Content-Type: application/json' \  -d '{}'
{  "data": {    "id": "string",    "name": "string",    "status": "active",    "trigger": "comment_created",    "channelIds": [      "string"    ],    "posts": [      {        "channelId": "string",        "label": "string",        "permalink": "string",        "waitingForScheduledPostId": "string"      }    ],    "keywords": [      "string"    ],    "keywordMode": "contains",    "excludeKeywords": [      "string"    ],    "contactKind": "any",    "actions": [      {        "type": "reply_comment",        "variants": [          "string"        ]      }    ],    "guardrails": {      "maxDmPerContactPerDay": 1,      "maxActionsPerHour": 1,      "quietHours": {        "enabled": true,        "from": "22:00",        "to": "22:00"      }    },    "summary": "string",    "canSwitchOn": true,    "blocker": "string",    "updatedAt": "2019-08-24T14:15:22Z"  }}