Automations

Comment-to-DM: when someone comments a keyword, answer with a private message (Instagram, Facebook) or a public reply (every network).

List automations

GET/v1/automations

Parameters

profileIdstringrequired
accountIdstring

Response 200

data []

idstringrequired
accountIdstringrequired
platformstringrequired
namestringrequired
triggerstringrequired
Values: comment · story_reply
postIdstring | nullrequired
inboxPostIdstring | nullrequired
keywordsstring[]required
matchModestringrequired
Values: contains · word · exact
excludeKeywordsstring[]required
dmMessagestring
buttonsobject[]required
buttons
- typestringrequired
  Values: url · postback
- titlestringrequired
- urlstring (uri)
- payloadstring
commentReplystring
dmDelaySecondsinteger
max 9,007,199,254,740,991
repeatstringrequired
Values: once · every_comment
likeCommentbooleanrequired
hideCommentbooleanrequired
activebooleanrequired
statsobjectrequired
stats
- triggeredintegerrequired
  max 9,007,199,254,740,991
- dmsSentintegerrequired
  max 9,007,199,254,740,991
- dmsFailedintegerrequired
  max 9,007,199,254,740,991
- uniqueContactsintegerrequired
  max 9,007,199,254,740,991
- linkClicksintegerrequired
  max 9,007,199,254,740,991
createdAtstring (date-time)

curl "https://api.usecrier.com/v1/automations" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/automations', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/automations",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Create an automation

POST/v1/automations

On Instagram and Facebook it sends dmMessage (with up to 3 buttons) to whoever comments a keyword; on TikTok, Threads, LinkedIn and YouTube it posts commentReply. Without a post it watches every post of the account.

Body

namestringrequired
max 100
triggerstring
story_reply: replies to an Instagram story.
Values: comment · story_replyDefault: "comment"
postIdstring | null
A Crier post to watch.
inboxPostIdstring | null
Or a post as GET /v1/inbox/posts lists it. Neither: every post.
keywordsstring[]
Empty: any comment fires it.
Default: []max 50 items
matchModestring
Values: contains · word · exactDefault: "contains"
excludeKeywordsstring[]
Default: []max 50 items
dmMessagestring
Private message to the commenter. Instagram and Facebook only, required there.
max 1,000
buttonsobject[]
Up to 3 buttons under the DM.
Default: []max 3 items
buttons
- typestringrequired
  Values: url · postback
- titlestringrequired
  max 20
- urlstring (uri)
- payloadstring
  max 1,000
commentReplystring
Public reply to the comment. Required on TikTok, Threads, LinkedIn and YouTube.
max 2,000
dmDelaySecondsinteger
max 86,400
repeatstring
once: one DM per person.
Values: once · every_commentDefault: "once"
likeCommentboolean
Default: false
hideCommentboolean
Default: false
activeboolean
Default: true
accountIdstringrequired
Instagram, Facebook, TikTok, Threads, LinkedIn or YouTube account.

Response 201

data

idstringrequired
accountIdstringrequired
platformstringrequired
namestringrequired
triggerstringrequired
Values: comment · story_reply
postIdstring | nullrequired
inboxPostIdstring | nullrequired
keywordsstring[]required
matchModestringrequired
Values: contains · word · exact
excludeKeywordsstring[]required
dmMessagestring
buttonsobject[]required
buttons
- typestringrequired
  Values: url · postback
- titlestringrequired
- urlstring (uri)
- payloadstring
commentReplystring
dmDelaySecondsinteger
max 9,007,199,254,740,991
repeatstringrequired
Values: once · every_comment
likeCommentbooleanrequired
hideCommentbooleanrequired
activebooleanrequired
statsobjectrequired
stats
- triggeredintegerrequired
  max 9,007,199,254,740,991
- dmsSentintegerrequired
  max 9,007,199,254,740,991
- dmsFailedintegerrequired
  max 9,007,199,254,740,991
- uniqueContactsintegerrequired
  max 9,007,199,254,740,991
- linkClicksintegerrequired
  max 9,007,199,254,740,991
createdAtstring (date-time)

curl -X POST "https://api.usecrier.com/v1/automations" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/automations', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.post(
    "https://api.usecrier.com/v1/automations",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Get an automation

GET/v1/automations/{id}

Parameters

idstringrequired

Response 200

data

idstringrequired
accountIdstringrequired
platformstringrequired
namestringrequired
triggerstringrequired
Values: comment · story_reply
postIdstring | nullrequired
inboxPostIdstring | nullrequired
keywordsstring[]required
matchModestringrequired
Values: contains · word · exact
excludeKeywordsstring[]required
dmMessagestring
buttonsobject[]required
buttons
- typestringrequired
  Values: url · postback
- titlestringrequired
- urlstring (uri)
- payloadstring
commentReplystring
dmDelaySecondsinteger
max 9,007,199,254,740,991
repeatstringrequired
Values: once · every_comment
likeCommentbooleanrequired
hideCommentbooleanrequired
activebooleanrequired
statsobjectrequired
stats
- triggeredintegerrequired
  max 9,007,199,254,740,991
- dmsSentintegerrequired
  max 9,007,199,254,740,991
- dmsFailedintegerrequired
  max 9,007,199,254,740,991
- uniqueContactsintegerrequired
  max 9,007,199,254,740,991
- linkClicksintegerrequired
  max 9,007,199,254,740,991
createdAtstring (date-time)

curl "https://api.usecrier.com/v1/automations/aut_6r3e9w" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/automations/aut_6r3e9w', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/automations/aut_6r3e9w",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Update or pause an automation

PATCH/v1/automations/{id}

Fields you leave out keep their value. active: false pauses it.

Parameters

idstringrequired

Body

namestring
max 100
triggerstring
story_reply: replies to an Instagram story.
Values: comment · story_reply
postIdstring | null
A Crier post to watch.
inboxPostIdstring | null
Or a post as GET /v1/inbox/posts lists it. Neither: every post.
keywordsstring[]
Empty: any comment fires it.
max 50 items
matchModestring
Values: contains · word · exact
excludeKeywordsstring[]
max 50 items
dmMessagestring
Private message to the commenter. Instagram and Facebook only, required there.
max 1,000
buttonsobject[]
Up to 3 buttons under the DM.
max 3 items
buttons
- typestringrequired
  Values: url · postback
- titlestringrequired
  max 20
- urlstring (uri)
- payloadstring
  max 1,000
commentReplystring
Public reply to the comment. Required on TikTok, Threads, LinkedIn and YouTube.
max 2,000
dmDelaySecondsinteger
max 86,400
repeatstring
once: one DM per person.
Values: once · every_comment
likeCommentboolean
hideCommentboolean
activeboolean

Response 200

data

idstringrequired
accountIdstringrequired
platformstringrequired
namestringrequired
triggerstringrequired
Values: comment · story_reply
postIdstring | nullrequired
inboxPostIdstring | nullrequired
keywordsstring[]required
matchModestringrequired
Values: contains · word · exact
excludeKeywordsstring[]required
dmMessagestring
buttonsobject[]required
buttons
- typestringrequired
  Values: url · postback
- titlestringrequired
- urlstring (uri)
- payloadstring
commentReplystring
dmDelaySecondsinteger
max 9,007,199,254,740,991
repeatstringrequired
Values: once · every_comment
likeCommentbooleanrequired
hideCommentbooleanrequired
activebooleanrequired
statsobjectrequired
stats
- triggeredintegerrequired
  max 9,007,199,254,740,991
- dmsSentintegerrequired
  max 9,007,199,254,740,991
- dmsFailedintegerrequired
  max 9,007,199,254,740,991
- uniqueContactsintegerrequired
  max 9,007,199,254,740,991
- linkClicksintegerrequired
  max 9,007,199,254,740,991
createdAtstring (date-time)

curl -X PATCH "https://api.usecrier.com/v1/automations/aut_6r3e9w" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/automations/aut_6r3e9w', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.patch(
    "https://api.usecrier.com/v1/automations/aut_6r3e9w",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Delete an automation

DELETE/v1/automations/{id}

Parameters

idstringrequired

Response 204

No content

curl -X DELETE "https://api.usecrier.com/v1/automations/aut_6r3e9w" \
  -H "Authorization: Bearer $CRIER_API_KEY"

await fetch('https://api.usecrier.com/v1/automations/aut_6r3e9w', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});

import os, requests

requests.delete(
    "https://api.usecrier.com/v1/automations/aut_6r3e9w",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)

What an automation did

GET/v1/automations/{id}/logs

Every comment that fired it, newest first, with the DM outcome.

Parameters

idstringrequired
skipinteger
max 9,007,199,254,740,991
limitinteger
max 100

Response 200

data

itemsobject[]required
items
- idstringrequired
- commenterobjectrequired
  commenter
  - namestring
  - usernamestring
- commentTextstring
- statusstringrequired
  Values: pending · sent · failed · skipped · gated
- errorstring
- replyStatusstring
- clickedbooleanrequired
- createdAtstring (date-time)required
totalintegerrequired
max 9,007,199,254,740,991

curl "https://api.usecrier.com/v1/automations/aut_6r3e9w/logs" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/automations/aut_6r3e9w/logs', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/automations/aut_6r3e9w/logs",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]