Automations API

Flows that react to comments and messages, with executions you can inspect.

Operation	Method and path
Get automation flows	GET `/api/v1/automations`
Create an automation flow	POST `/api/v1/automations`
Copy automation flows between teams	POST `/api/v1/automations/copy`
Get an automation flow	GET `/api/v1/automations/{id}`
Update an automation flow	PATCH `/api/v1/automations/{id}`
Delete an automation flow	DELETE `/api/v1/automations/{id}`
Publish an automation flow	POST `/api/v1/automations/{id}/publish`
Pause an automation flow	POST `/api/v1/automations/{id}/pause`
Activate an automation flow	POST `/api/v1/automations/{id}/activate`
Archive an automation flow	POST `/api/v1/automations/{id}/archive`
Get automation flow executions	GET `/api/v1/automations/{id}/executions`
Get an automation execution	GET `/api/v1/automation-executions/{id}`
Run an automation flow test	POST `/api/v1/automations/{id}/test`
Get automation provider settings	GET `/api/v1/automation-provider-settings`
Create or update automation provider settings	PUT `/api/v1/automation-provider-settings/{socialAccountId}/{type}`
Sync automation provider settings	POST `/api/v1/automation-provider-settings/{id}/sync`
Send a rich automation message to a conversation	POST `/api/v1/automation-rich-messages/conversations/{conversationId}`

GET /api/v1/automations

Get automation flows

automation.getFlows · requires x-api-key

Parameters

Name	In	Type	Notes
`teamId` required	query	`string`
`status`	query	`string`	One of DRAFT, ACTIVE, PAUSED, ARCHIVED
`platformScope`	query	`string`	One of INSTAGRAM, FACEBOOK, BOTH, TIKTOK
`socialAccountId`	query	`string`
`offset`	query	`number`	default 0 · nullable
`limit`	query	`number`	default 10 · nullable

Example

curl -X GET "https://api.siaran.my/api/v1/automations?teamId=TEAM_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response `200`

2 top-level fields

items object[] required
12 fields
- id string required
- teamId string required
- organizationId string nullable
- name string required
- status string required
  
  One of: DRAFT ACTIVE PAUSED ARCHIVED
- platformScope string required
  
  One of: INSTAGRAM FACEBOOK BOTH TIKTOK
- createdByUserId string nullable
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
- deletedAt string nullable date-time
- draftVersion object
  8 fields
  - id string required
  - flowId string required
  - version number required
  - status string required
    
    One of: DRAFT PUBLISHED RETIRED
  - definition object required
    
    2 fields
    
    trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
    
    steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
  - publishedAt string nullable date-time
  - publishedByUserId string nullable
  - createdAt string required nullable date-time
- publishedVersion object
  8 fields
  - id string required
  - flowId string required
  - version number required
  - status string required
    
    One of: DRAFT PUBLISHED RETIRED
  - definition object required
    
    2 fields
    
    trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
    
    steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
  - publishedAt string nullable date-time
  - publishedByUserId string nullable
  - createdAt string required nullable date-time
total number required

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

POST /api/v1/automations

Create an automation flow

automation.createFlow · requires x-api-key

Request body `application/json`

teamId string required
name string required min length 1max length 120
platformScope string required

One of: INSTAGRAM FACEBOOK BOTH TIKTOK
definition object
2 fields
- trigger object required
  11 fields
  - keywords string[] max 100 itemseach: min length 1each: max length 200
  - matchMode string default "ANY"
    
    One of: ANY ALL
  - caseSensitive boolean default false
  - senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
  - payloads string[] max 100 itemseach: min length 1each: max length 1,000
  - actionDelaySeconds integer default 0 ≥ 0≤ 86400
  - id string min length 1max length 36
  - type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
  - platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
  - socialAccountId string required
  - postId string nullable
- steps object | object | object | object | object | object | object[] required min 1 itemsmax 100 items
  One of 7 shapes
  type = CONDITION
  
  id string min length 1max length 36
  
  type string required
  
  One of: CONDITION
  
  conditions object[] required min 1 items
  
  5 fields
  
  id string min length 1max length 36
  
  field string required
  
  One of: TEXT PAYLOAD PLATFORM SENDER_ID
  
  operator string required
  
  One of: CONTAINS EQUALS MATCHES_ANY
  
  value string required min length 1max length 1,000
  
  caseSensitive boolean default false
  type = SEND_MESSAGE
  
  id string min length 1max length 36
  
  type string required
  
  One of: SEND_MESSAGE
  
  message object required
  
  5 fields
  
  text string max length 1,000
  
  attachments object[] max 10 items
  
  2 fields
  
  uploadId string required min length 1
  
  type string required
  
  One of: IMAGE VIDEO AUDIO FILE
  
  quickReplies object[] max 13 items
  
  3 fields
  
  id string required min length 1max length 36
  
  label string required min length 1max length 20
  
  payload string required min length 1max length 1,000
  
  buttons object | object | object[] max 3 items
  
  One of 3 shapes
  
  type = POSTBACK
  
  id string required min length 1max length 36
  
  type string required
  
  One of: POSTBACK
  
  label string required min length 1max length 20
  
  payload string required min length 1max length 1,000
  
  type = URL
  
  id string required min length 1max length 36
  
  type string required
  
  One of: URL
  
  label string required min length 1max length 20
  
  url string required uri
  
  type = PHONE
  
  id string required min length 1max length 36
  
  type string required
  
  One of: PHONE
  
  label string required min length 1max length 20
  
  phoneNumber string required min length 3max length 30
  
  carousel object
  
  1 field
  
  cards object[] required min 1 itemsmax 10 items
  
  5 fields
  
  id string required min length 1max length 36
  
  title string required min length 1max length 80
  
  subtitle string nullable max length 80
  
  imageUploadId string nullable min length 1
  
  buttons object | object | object[] max 3 items
  
  One of 3 shapes
  
  type = POSTBACK
  
  id string required min length 1max length 36
  
  type string required
  
  One of: POSTBACK
  
  label string required min length 1max length 20
  
  payload string required min length 1max length 1,000
  
  type = URL
  
  id string required min length 1max length 36
  
  type string required
  
  One of: URL
  
  label string required min length 1max length 20
  
  url string required uri
  
  type = PHONE
  
  id string required min length 1max length 36
  
  type string required
  
  One of: PHONE
  
  label string required min length 1max length 20
  
  phoneNumber string required min length 3max length 30
  type = SEND_PRIVATE_REPLY
  
  id string min length 1max length 36
  
  type string required
  
  One of: SEND_PRIVATE_REPLY
  
  message object required
  
  5 fields
  
  text string max length 1,000
  
  attachments object[] max 10 items
  
  2 fields
  
  uploadId string required min length 1
  
  type string required
  
  One of: IMAGE VIDEO AUDIO FILE
  
  quickReplies object[] max 13 items
  
  3 fields
  
  id string required min length 1max length 36
  
  label string required min length 1max length 20
  
  payload string required min length 1max length 1,000
  
  buttons object | object | object[] max 3 items
  
  One of 3 shapes
  
  type = POSTBACK
  
  id string required min length 1max length 36
  
  type string required
  
  One of: POSTBACK
  
  label string required min length 1max length 20
  
  payload string required min length 1max length 1,000
  
  type = URL
  
  id string required min length 1max length 36
  
  type string required
  
  One of: URL
  
  label string required min length 1max length 20
  
  url string required uri
  
  type = PHONE
  
  id string required min length 1max length 36
  
  type string required
  
  One of: PHONE
  
  label string required min length 1max length 20
  
  phoneNumber string required min length 3max length 30
  
  carousel object
  
  1 field
  
  cards object[] required min 1 itemsmax 10 items
  
  5 fields
  
  id string required min length 1max length 36
  
  title string required min length 1max length 80
  
  subtitle string nullable max length 80
  
  imageUploadId string nullable min length 1
  
  buttons object | object | object[] max 3 items
  
  One of 3 shapes
  
  type = POSTBACK
  
  id string required min length 1max length 36
  
  type string required
  
  One of: POSTBACK
  
  label string required min length 1max length 20
  
  payload string required min length 1max length 1,000
  
  type = URL
  
  id string required min length 1max length 36
  
  type string required
  
  One of: URL
  
  label string required min length 1max length 20
  
  url string required uri
  
  type = PHONE
  
  id string required min length 1max length 36
  
  type string required
  
  One of: PHONE
  
  label string required min length 1max length 20
  
  phoneNumber string required min length 3max length 30
  type = SEND_PUBLIC_COMMENT_REPLY
  
  id string min length 1max length 36
  
  type string required
  
  One of: SEND_PUBLIC_COMMENT_REPLY
  
  text string required min length 1max length 1,000
  type = LIKE_COMMENT
  
  id string min length 1max length 36
  
  type string required
  
  One of: LIKE_COMMENT
  type = ARCHIVE_CONVERSATION
  
  id string min length 1max length 36
  
  type string required
  
  One of: ARCHIVE_CONVERSATION
  type = OPEN_CONVERSATION
  
  id string min length 1max length 36
  
  type string required
  
  One of: OPEN_CONVERSATION

Example

curl -X POST "https://api.siaran.my/api/v1/automations" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "name": "Example",
    "platformScope": "INSTAGRAM"
  }'

Response `201`

12 top-level fields

id string required
teamId string required
organizationId string nullable
name string required
status string required

One of: DRAFT ACTIVE PAUSED ARCHIVED
platformScope string required

One of: INSTAGRAM FACEBOOK BOTH TIKTOK
createdByUserId string nullable
createdAt string required nullable date-time
updatedAt string required nullable date-time
deletedAt string nullable date-time
draftVersion object
8 fields
- id string required
- flowId string required
- version number required
- status string required
  
  One of: DRAFT PUBLISHED RETIRED
- definition object required
  2 fields
  - trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
  - steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
- publishedAt string nullable date-time
- publishedByUserId string nullable
- createdAt string required nullable date-time
publishedVersion object
8 fields
- id string required
- flowId string required
- version number required
- status string required
  
  One of: DRAFT PUBLISHED RETIRED
- definition object required
  2 fields
  - trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
  - steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
- publishedAt string nullable date-time
- publishedByUserId string nullable
- createdAt string required nullable date-time

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

POST /api/v1/automations/copy

Copy automation flows between teams

automation.copyFlows · requires x-api-key

Request body `application/json`

sourceTeamId string required
targetTeamId string required
flowId string

Example

curl -X POST "https://api.siaran.my/api/v1/automations/copy" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "sourceTeamId": "SOURCETEAM_ID",
    "targetTeamId": "TARGETTEAM_ID"
  }'

Response `201`

2 top-level fields

items object[] required
12 fields
- id string required
- teamId string required
- organizationId string nullable
- name string required
- status string required
  
  One of: DRAFT ACTIVE PAUSED ARCHIVED
- platformScope string required
  
  One of: INSTAGRAM FACEBOOK BOTH TIKTOK
- createdByUserId string nullable
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
- deletedAt string nullable date-time
- draftVersion object
  8 fields
  - id string required
  - flowId string required
  - version number required
  - status string required
    
    One of: DRAFT PUBLISHED RETIRED
  - definition object required
    
    2 fields
    
    trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
    
    steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
  - publishedAt string nullable date-time
  - publishedByUserId string nullable
  - createdAt string required nullable date-time
- publishedVersion object
  8 fields
  - id string required
  - flowId string required
  - version number required
  - status string required
    
    One of: DRAFT PUBLISHED RETIRED
  - definition object required
    
    2 fields
    
    trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
    
    steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
  - publishedAt string nullable date-time
  - publishedByUserId string nullable
  - createdAt string required nullable date-time
total number required

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

GET /api/v1/automations/{id}

Get an automation flow

automation.getFlow · requires x-api-key

Parameters

Name	In	Type	Notes
`id` required	path	`string`

Example

curl -X GET "https://api.siaran.my/api/v1/automations/ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response `200`

12 top-level fields

id string required
teamId string required
organizationId string nullable
name string required
status string required

One of: DRAFT ACTIVE PAUSED ARCHIVED
platformScope string required

One of: INSTAGRAM FACEBOOK BOTH TIKTOK
createdByUserId string nullable
createdAt string required nullable date-time
updatedAt string required nullable date-time
deletedAt string nullable date-time
draftVersion object
8 fields
- id string required
- flowId string required
- version number required
- status string required
  
  One of: DRAFT PUBLISHED RETIRED
- definition object required
  2 fields
  - trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
  - steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
- publishedAt string nullable date-time
- publishedByUserId string nullable
- createdAt string required nullable date-time
publishedVersion object
8 fields
- id string required
- flowId string required
- version number required
- status string required
  
  One of: DRAFT PUBLISHED RETIRED
- definition object required
  2 fields
  - trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
  - steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
- publishedAt string nullable date-time
- publishedByUserId string nullable
- createdAt string required nullable date-time

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

PATCH /api/v1/automations/{id}

Update an automation flow

automation.updateFlow · requires x-api-key

Parameters

Name	In	Type	Notes
`id` required	path	`string`

Request body `application/json`

name string min length 1max length 120
platformScope string

One of: INSTAGRAM FACEBOOK BOTH TIKTOK
definition object
2 fields
- trigger object required
  11 fields
  - keywords string[] max 100 itemseach: min length 1each: max length 200
  - matchMode string default "ANY"
    
    One of: ANY ALL
  - caseSensitive boolean default false
  - senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
  - payloads string[] max 100 itemseach: min length 1each: max length 1,000
  - actionDelaySeconds integer default 0 ≥ 0≤ 86400
  - id string min length 1max length 36
  - type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
  - platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
  - socialAccountId string required
  - postId string nullable
- steps object | object | object | object | object | object | object[] required min 1 itemsmax 100 items
  One of 7 shapes
  type = CONDITION
  
  id string min length 1max length 36
  
  type string required
  
  One of: CONDITION
  
  conditions object[] required min 1 items
  
  5 fields
  
  id string min length 1max length 36
  
  field string required
  
  One of: TEXT PAYLOAD PLATFORM SENDER_ID
  
  operator string required
  
  One of: CONTAINS EQUALS MATCHES_ANY
  
  value string required min length 1max length 1,000
  
  caseSensitive boolean default false
  type = SEND_MESSAGE
  
  id string min length 1max length 36
  
  type string required
  
  One of: SEND_MESSAGE
  
  message object required
  
  5 fields
  
  text string max length 1,000
  
  attachments object[] max 10 items
  
  2 fields
  
  uploadId string required min length 1
  
  type string required
  
  One of: IMAGE VIDEO AUDIO FILE
  
  quickReplies object[] max 13 items
  
  3 fields
  
  id string required min length 1max length 36
  
  label string required min length 1max length 20
  
  payload string required min length 1max length 1,000
  
  buttons object | object | object[] max 3 items
  
  One of 3 shapes
  
  type = POSTBACK
  
  id string required min length 1max length 36
  
  type string required
  
  One of: POSTBACK
  
  label string required min length 1max length 20
  
  payload string required min length 1max length 1,000
  
  type = URL
  
  id string required min length 1max length 36
  
  type string required
  
  One of: URL
  
  label string required min length 1max length 20
  
  url string required uri
  
  type = PHONE
  
  id string required min length 1max length 36
  
  type string required
  
  One of: PHONE
  
  label string required min length 1max length 20
  
  phoneNumber string required min length 3max length 30
  
  carousel object
  
  1 field
  
  cards object[] required min 1 itemsmax 10 items
  
  5 fields
  
  id string required min length 1max length 36
  
  title string required min length 1max length 80
  
  subtitle string nullable max length 80
  
  imageUploadId string nullable min length 1
  
  buttons object | object | object[] max 3 items
  
  One of 3 shapes
  
  type = POSTBACK
  
  id string required min length 1max length 36
  
  type string required
  
  One of: POSTBACK
  
  label string required min length 1max length 20
  
  payload string required min length 1max length 1,000
  
  type = URL
  
  id string required min length 1max length 36
  
  type string required
  
  One of: URL
  
  label string required min length 1max length 20
  
  url string required uri
  
  type = PHONE
  
  id string required min length 1max length 36
  
  type string required
  
  One of: PHONE
  
  label string required min length 1max length 20
  
  phoneNumber string required min length 3max length 30
  type = SEND_PRIVATE_REPLY
  
  id string min length 1max length 36
  
  type string required
  
  One of: SEND_PRIVATE_REPLY
  
  message object required
  
  5 fields
  
  text string max length 1,000
  
  attachments object[] max 10 items
  
  2 fields
  
  uploadId string required min length 1
  
  type string required
  
  One of: IMAGE VIDEO AUDIO FILE
  
  quickReplies object[] max 13 items
  
  3 fields
  
  id string required min length 1max length 36
  
  label string required min length 1max length 20
  
  payload string required min length 1max length 1,000
  
  buttons object | object | object[] max 3 items
  
  One of 3 shapes
  
  type = POSTBACK
  
  id string required min length 1max length 36
  
  type string required
  
  One of: POSTBACK
  
  label string required min length 1max length 20
  
  payload string required min length 1max length 1,000
  
  type = URL
  
  id string required min length 1max length 36
  
  type string required
  
  One of: URL
  
  label string required min length 1max length 20
  
  url string required uri
  
  type = PHONE
  
  id string required min length 1max length 36
  
  type string required
  
  One of: PHONE
  
  label string required min length 1max length 20
  
  phoneNumber string required min length 3max length 30
  
  carousel object
  
  1 field
  
  cards object[] required min 1 itemsmax 10 items
  
  5 fields
  
  id string required min length 1max length 36
  
  title string required min length 1max length 80
  
  subtitle string nullable max length 80
  
  imageUploadId string nullable min length 1
  
  buttons object | object | object[] max 3 items
  
  One of 3 shapes
  
  type = POSTBACK
  
  id string required min length 1max length 36
  
  type string required
  
  One of: POSTBACK
  
  label string required min length 1max length 20
  
  payload string required min length 1max length 1,000
  
  type = URL
  
  id string required min length 1max length 36
  
  type string required
  
  One of: URL
  
  label string required min length 1max length 20
  
  url string required uri
  
  type = PHONE
  
  id string required min length 1max length 36
  
  type string required
  
  One of: PHONE
  
  label string required min length 1max length 20
  
  phoneNumber string required min length 3max length 30
  type = SEND_PUBLIC_COMMENT_REPLY
  
  id string min length 1max length 36
  
  type string required
  
  One of: SEND_PUBLIC_COMMENT_REPLY
  
  text string required min length 1max length 1,000
  type = LIKE_COMMENT
  
  id string min length 1max length 36
  
  type string required
  
  One of: LIKE_COMMENT
  type = ARCHIVE_CONVERSATION
  
  id string min length 1max length 36
  
  type string required
  
  One of: ARCHIVE_CONVERSATION
  type = OPEN_CONVERSATION
  
  id string min length 1max length 36
  
  type string required
  
  One of: OPEN_CONVERSATION

Example

curl -X PATCH "https://api.siaran.my/api/v1/automations/ID" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "name": "Example",
    "platformScope": "INSTAGRAM",
    "definition": {
      "trigger": {
        "type": "COMMENT_CREATED",
        "platform": "INSTAGRAM",
        "socialAccountId": "SOCIALACCOUNT_ID"
      },
      "steps": [
        {
          "type": "CONDITION",
          "conditions": [
            {
              "field": "TEXT",
              "operator": "CONTAINS",
              "value": "string"
            }
          ]
        }
      ]
    }
  }'

Response `200`

12 top-level fields

id string required
teamId string required
organizationId string nullable
name string required
status string required

One of: DRAFT ACTIVE PAUSED ARCHIVED
platformScope string required

One of: INSTAGRAM FACEBOOK BOTH TIKTOK
createdByUserId string nullable
createdAt string required nullable date-time
updatedAt string required nullable date-time
deletedAt string nullable date-time
draftVersion object
8 fields
- id string required
- flowId string required
- version number required
- status string required
  
  One of: DRAFT PUBLISHED RETIRED
- definition object required
  2 fields
  - trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
  - steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
- publishedAt string nullable date-time
- publishedByUserId string nullable
- createdAt string required nullable date-time
publishedVersion object
8 fields
- id string required
- flowId string required
- version number required
- status string required
  
  One of: DRAFT PUBLISHED RETIRED
- definition object required
  2 fields
  - trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
  - steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
- publishedAt string nullable date-time
- publishedByUserId string nullable
- createdAt string required nullable date-time

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

DELETE /api/v1/automations/{id}

Delete an automation flow

automation.deleteFlow · requires x-api-key

Parameters

Name	In	Type	Notes
`id` required	path	`string`

Example

curl -X DELETE "https://api.siaran.my/api/v1/automations/ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response `200`

12 top-level fields

id string required
teamId string required
organizationId string nullable
name string required
status string required

One of: DRAFT ACTIVE PAUSED ARCHIVED
platformScope string required

One of: INSTAGRAM FACEBOOK BOTH TIKTOK
createdByUserId string nullable
createdAt string required nullable date-time
updatedAt string required nullable date-time
deletedAt string nullable date-time
draftVersion object
8 fields
- id string required
- flowId string required
- version number required
- status string required
  
  One of: DRAFT PUBLISHED RETIRED
- definition object required
  2 fields
  - trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
  - steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
- publishedAt string nullable date-time
- publishedByUserId string nullable
- createdAt string required nullable date-time
publishedVersion object
8 fields
- id string required
- flowId string required
- version number required
- status string required
  
  One of: DRAFT PUBLISHED RETIRED
- definition object required
  2 fields
  - trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
  - steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
- publishedAt string nullable date-time
- publishedByUserId string nullable
- createdAt string required nullable date-time

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

POST /api/v1/automations/{id}/publish

Publish an automation flow

automation.publishFlow · requires x-api-key

Parameters

Name	In	Type	Notes
`id` required	path	`string`

Request body `application/json`

definition object
2 fields
- trigger object required
  11 fields
  - keywords string[] max 100 itemseach: min length 1each: max length 200
  - matchMode string default "ANY"
    
    One of: ANY ALL
  - caseSensitive boolean default false
  - senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
  - payloads string[] max 100 itemseach: min length 1each: max length 1,000
  - actionDelaySeconds integer default 0 ≥ 0≤ 86400
  - id string min length 1max length 36
  - type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
  - platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
  - socialAccountId string required
  - postId string nullable
- steps object | object | object | object | object | object | object[] required min 1 itemsmax 100 items
  One of 7 shapes
  type = CONDITION
  
  id string min length 1max length 36
  
  type string required
  
  One of: CONDITION
  
  conditions object[] required min 1 items
  
  5 fields
  
  id string min length 1max length 36
  
  field string required
  
  One of: TEXT PAYLOAD PLATFORM SENDER_ID
  
  operator string required
  
  One of: CONTAINS EQUALS MATCHES_ANY
  
  value string required min length 1max length 1,000
  
  caseSensitive boolean default false
  type = SEND_MESSAGE
  
  id string min length 1max length 36
  
  type string required
  
  One of: SEND_MESSAGE
  
  message object required
  
  5 fields
  
  text string max length 1,000
  
  attachments object[] max 10 items
  
  2 fields
  
  uploadId string required min length 1
  
  type string required
  
  One of: IMAGE VIDEO AUDIO FILE
  
  quickReplies object[] max 13 items
  
  3 fields
  
  id string required min length 1max length 36
  
  label string required min length 1max length 20
  
  payload string required min length 1max length 1,000
  
  buttons object | object | object[] max 3 items
  
  One of 3 shapes
  
  type = POSTBACK
  
  id string required min length 1max length 36
  
  type string required
  
  One of: POSTBACK
  
  label string required min length 1max length 20
  
  payload string required min length 1max length 1,000
  
  type = URL
  
  id string required min length 1max length 36
  
  type string required
  
  One of: URL
  
  label string required min length 1max length 20
  
  url string required uri
  
  type = PHONE
  
  id string required min length 1max length 36
  
  type string required
  
  One of: PHONE
  
  label string required min length 1max length 20
  
  phoneNumber string required min length 3max length 30
  
  carousel object
  
  1 field
  
  cards object[] required min 1 itemsmax 10 items
  
  5 fields
  
  id string required min length 1max length 36
  
  title string required min length 1max length 80
  
  subtitle string nullable max length 80
  
  imageUploadId string nullable min length 1
  
  buttons object | object | object[] max 3 items
  
  One of 3 shapes
  
  type = POSTBACK
  
  id string required min length 1max length 36
  
  type string required
  
  One of: POSTBACK
  
  label string required min length 1max length 20
  
  payload string required min length 1max length 1,000
  
  type = URL
  
  id string required min length 1max length 36
  
  type string required
  
  One of: URL
  
  label string required min length 1max length 20
  
  url string required uri
  
  type = PHONE
  
  id string required min length 1max length 36
  
  type string required
  
  One of: PHONE
  
  label string required min length 1max length 20
  
  phoneNumber string required min length 3max length 30
  type = SEND_PRIVATE_REPLY
  
  id string min length 1max length 36
  
  type string required
  
  One of: SEND_PRIVATE_REPLY
  
  message object required
  
  5 fields
  
  text string max length 1,000
  
  attachments object[] max 10 items
  
  2 fields
  
  uploadId string required min length 1
  
  type string required
  
  One of: IMAGE VIDEO AUDIO FILE
  
  quickReplies object[] max 13 items
  
  3 fields
  
  id string required min length 1max length 36
  
  label string required min length 1max length 20
  
  payload string required min length 1max length 1,000
  
  buttons object | object | object[] max 3 items
  
  One of 3 shapes
  
  type = POSTBACK
  
  id string required min length 1max length 36
  
  type string required
  
  One of: POSTBACK
  
  label string required min length 1max length 20
  
  payload string required min length 1max length 1,000
  
  type = URL
  
  id string required min length 1max length 36
  
  type string required
  
  One of: URL
  
  label string required min length 1max length 20
  
  url string required uri
  
  type = PHONE
  
  id string required min length 1max length 36
  
  type string required
  
  One of: PHONE
  
  label string required min length 1max length 20
  
  phoneNumber string required min length 3max length 30
  
  carousel object
  
  1 field
  
  cards object[] required min 1 itemsmax 10 items
  
  5 fields
  
  id string required min length 1max length 36
  
  title string required min length 1max length 80
  
  subtitle string nullable max length 80
  
  imageUploadId string nullable min length 1
  
  buttons object | object | object[] max 3 items
  
  One of 3 shapes
  
  type = POSTBACK
  
  id string required min length 1max length 36
  
  type string required
  
  One of: POSTBACK
  
  label string required min length 1max length 20
  
  payload string required min length 1max length 1,000
  
  type = URL
  
  id string required min length 1max length 36
  
  type string required
  
  One of: URL
  
  label string required min length 1max length 20
  
  url string required uri
  
  type = PHONE
  
  id string required min length 1max length 36
  
  type string required
  
  One of: PHONE
  
  label string required min length 1max length 20
  
  phoneNumber string required min length 3max length 30
  type = SEND_PUBLIC_COMMENT_REPLY
  
  id string min length 1max length 36
  
  type string required
  
  One of: SEND_PUBLIC_COMMENT_REPLY
  
  text string required min length 1max length 1,000
  type = LIKE_COMMENT
  
  id string min length 1max length 36
  
  type string required
  
  One of: LIKE_COMMENT
  type = ARCHIVE_CONVERSATION
  
  id string min length 1max length 36
  
  type string required
  
  One of: ARCHIVE_CONVERSATION
  type = OPEN_CONVERSATION
  
  id string min length 1max length 36
  
  type string required
  
  One of: OPEN_CONVERSATION

Example

curl -X POST "https://api.siaran.my/api/v1/automations/ID/publish" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "definition": {
      "trigger": {
        "type": "COMMENT_CREATED",
        "platform": "INSTAGRAM",
        "socialAccountId": "SOCIALACCOUNT_ID"
      },
      "steps": [
        {
          "type": "CONDITION",
          "conditions": [
            {
              "field": "TEXT",
              "operator": "CONTAINS",
              "value": "string"
            }
          ]
        }
      ]
    }
  }'

Response `200`

12 top-level fields

id string required
teamId string required
organizationId string nullable
name string required
status string required

One of: DRAFT ACTIVE PAUSED ARCHIVED
platformScope string required

One of: INSTAGRAM FACEBOOK BOTH TIKTOK
createdByUserId string nullable
createdAt string required nullable date-time
updatedAt string required nullable date-time
deletedAt string nullable date-time
draftVersion object
8 fields
- id string required
- flowId string required
- version number required
- status string required
  
  One of: DRAFT PUBLISHED RETIRED
- definition object required
  2 fields
  - trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
  - steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
- publishedAt string nullable date-time
- publishedByUserId string nullable
- createdAt string required nullable date-time
publishedVersion object
8 fields
- id string required
- flowId string required
- version number required
- status string required
  
  One of: DRAFT PUBLISHED RETIRED
- definition object required
  2 fields
  - trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
  - steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
- publishedAt string nullable date-time
- publishedByUserId string nullable
- createdAt string required nullable date-time

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

POST /api/v1/automations/{id}/pause

Pause an automation flow

automation.pauseFlow · requires x-api-key

Parameters

Name	In	Type	Notes
`id` required	path	`string`

Example

curl -X POST "https://api.siaran.my/api/v1/automations/ID/pause" \
  -H "x-api-key: $SIAR_API_KEY"

Response `200`

12 top-level fields

id string required
teamId string required
organizationId string nullable
name string required
status string required

One of: DRAFT ACTIVE PAUSED ARCHIVED
platformScope string required

One of: INSTAGRAM FACEBOOK BOTH TIKTOK
createdByUserId string nullable
createdAt string required nullable date-time
updatedAt string required nullable date-time
deletedAt string nullable date-time
draftVersion object
8 fields
- id string required
- flowId string required
- version number required
- status string required
  
  One of: DRAFT PUBLISHED RETIRED
- definition object required
  2 fields
  - trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
  - steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
- publishedAt string nullable date-time
- publishedByUserId string nullable
- createdAt string required nullable date-time
publishedVersion object
8 fields
- id string required
- flowId string required
- version number required
- status string required
  
  One of: DRAFT PUBLISHED RETIRED
- definition object required
  2 fields
  - trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
  - steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
- publishedAt string nullable date-time
- publishedByUserId string nullable
- createdAt string required nullable date-time

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

POST /api/v1/automations/{id}/activate

Activate an automation flow

automation.activateFlow · requires x-api-key

Parameters

Name	In	Type	Notes
`id` required	path	`string`

Example

curl -X POST "https://api.siaran.my/api/v1/automations/ID/activate" \
  -H "x-api-key: $SIAR_API_KEY"

Response `200`

12 top-level fields

id string required
teamId string required
organizationId string nullable
name string required
status string required

One of: DRAFT ACTIVE PAUSED ARCHIVED
platformScope string required

One of: INSTAGRAM FACEBOOK BOTH TIKTOK
createdByUserId string nullable
createdAt string required nullable date-time
updatedAt string required nullable date-time
deletedAt string nullable date-time
draftVersion object
8 fields
- id string required
- flowId string required
- version number required
- status string required
  
  One of: DRAFT PUBLISHED RETIRED
- definition object required
  2 fields
  - trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
  - steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
- publishedAt string nullable date-time
- publishedByUserId string nullable
- createdAt string required nullable date-time
publishedVersion object
8 fields
- id string required
- flowId string required
- version number required
- status string required
  
  One of: DRAFT PUBLISHED RETIRED
- definition object required
  2 fields
  - trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
  - steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
- publishedAt string nullable date-time
- publishedByUserId string nullable
- createdAt string required nullable date-time

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

POST /api/v1/automations/{id}/archive

Archive an automation flow

automation.archiveFlow · requires x-api-key

Parameters

Name	In	Type	Notes
`id` required	path	`string`

Example

curl -X POST "https://api.siaran.my/api/v1/automations/ID/archive" \
  -H "x-api-key: $SIAR_API_KEY"

Response `200`

12 top-level fields

id string required
teamId string required
organizationId string nullable
name string required
status string required

One of: DRAFT ACTIVE PAUSED ARCHIVED
platformScope string required

One of: INSTAGRAM FACEBOOK BOTH TIKTOK
createdByUserId string nullable
createdAt string required nullable date-time
updatedAt string required nullable date-time
deletedAt string nullable date-time
draftVersion object
8 fields
- id string required
- flowId string required
- version number required
- status string required
  
  One of: DRAFT PUBLISHED RETIRED
- definition object required
  2 fields
  - trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
  - steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
- publishedAt string nullable date-time
- publishedByUserId string nullable
- createdAt string required nullable date-time
publishedVersion object
8 fields
- id string required
- flowId string required
- version number required
- status string required
  
  One of: DRAFT PUBLISHED RETIRED
- definition object required
  2 fields
  - trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
  - steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
- publishedAt string nullable date-time
- publishedByUserId string nullable
- createdAt string required nullable date-time

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

GET /api/v1/automations/{id}/executions

Get automation flow executions

automation.getFlowExecutions · requires x-api-key

Parameters

Name	In	Type	Notes
`id` required	path	`string`
`teamId` required	query	`string`
`flowVersionId`	query	`string`
`triggerId`	query	`string`
`socialAccountId`	query	`string`
`platform`	query	`string`	One of INSTAGRAM, FACEBOOK, TIKTOK
`status`	query	`string`	One of QUEUED, RUNNING, COMPLETED, FAILED, CANCELED, SKIPPED
`conversationId`	query	`string`
`fetchedCommentId`	query	`string`
`offset`	query	`integer`	default 0 · nullable
`limit`	query	`integer`	default 10 · nullable
`cursor`	query	`string`	nullable

Example

curl -X GET "https://api.siaran.my/api/v1/automations/ID/executions?teamId=TEAM_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response `200`

3 top-level fields

items object[] required
29 fields
- id string required
- teamId string required
- organizationId string nullable
- flowId string required
- flowVersionId string required
- triggerId string nullable
- platform string required
  
  One of: INSTAGRAM FACEBOOK TIKTOK
- socialAccountId string required
- conversationId string nullable
- conversationMessageId string nullable
- fetchedCommentId string nullable
- senderExternalId string nullable
- currentStepId string nullable
- status string required
  
  One of: QUEUED RUNNING COMPLETED FAILED CANCELED SKIPPED
- idempotencyKey string required
- input object default {}
  11 fields
  - type string nullable
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
  - platform string nullable
    
    One of: INSTAGRAM FACEBOOK TIKTOK
  - socialAccountId string nullable
  - postId string nullable
  - conversationId string nullable
  - conversationMessageId string nullable
  - fetchedCommentId string nullable
  - senderExternalId string nullable
  - externalMessageId string nullable
  - text string nullable
  - payload string nullable
- output object default {}
- error object nullable
  3 fields
  - code string nullable
  - message string nullable
  - retryable boolean nullable
- startedAt string nullable date-time
- completedAt string nullable date-time
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
- flow object
  12 fields
  - id string required
  - teamId string required
  - organizationId string nullable
  - name string required
  - status string required
    
    One of: DRAFT ACTIVE PAUSED ARCHIVED
  - platformScope string required
    
    One of: INSTAGRAM FACEBOOK BOTH TIKTOK
  - createdByUserId string nullable
  - createdAt string required nullable date-time
  - updatedAt string required nullable date-time
  - deletedAt string nullable date-time
  - draftVersion object
    
    8 fields
    
    id string required
    
    flowId string required
    
    version number required
    
    status string required
    
    One of: DRAFT PUBLISHED RETIRED
    
    definition object required
    
    2 fields
    
    trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
    
    steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    type = URL
    
    type = PHONE
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    type = URL
    
    type = PHONE
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
    
    publishedAt string nullable date-time
    
    publishedByUserId string nullable
    
    createdAt string required nullable date-time
  - publishedVersion object
    
    8 fields
    
    id string required
    
    flowId string required
    
    version number required
    
    status string required
    
    One of: DRAFT PUBLISHED RETIRED
    
    definition object required
    
    2 fields
    
    trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
    
    steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    type = URL
    
    type = PHONE
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    type = URL
    
    type = PHONE
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
    
    publishedAt string nullable date-time
    
    publishedByUserId string nullable
    
    createdAt string required nullable date-time
- flowVersion object
  8 fields
  - id string required
  - flowId string required
  - version number required
  - status string required
    
    One of: DRAFT PUBLISHED RETIRED
  - definition object required
    
    2 fields
    
    trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
    
    steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
  - publishedAt string nullable date-time
  - publishedByUserId string nullable
  - createdAt string required nullable date-time
- steps object[]
  12 fields
  - id string required
  - executionId string required
  - stepId string nullable
  - status string required
    
    One of: PENDING RUNNING COMPLETED FAILED SKIPPED
  - attemptCount number required
  - input object default {}
    
    11 fields
    
    type string nullable
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string nullable
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string nullable
    
    postId string nullable
    
    conversationId string nullable
    
    conversationMessageId string nullable
    
    fetchedCommentId string nullable
    
    senderExternalId string nullable
    
    externalMessageId string nullable
    
    text string nullable
    
    payload string nullable
  - output object default {}
  - error object nullable
    
    3 fields
    
    code string nullable
    
    message string nullable
    
    retryable boolean nullable
  - startedAt string nullable date-time
  - completedAt string nullable date-time
  - createdAt string required nullable date-time
  - updatedAt string required nullable date-time
- conversation object nullable
  20 fields
  - id string required
  - teamId string required
  - socialAccountId string required
  - platform string required
    
    One of: INSTAGRAM FACEBOOK
  - externalConversationId string nullable
  - externalParticipantId string required
  - participantUsername string nullable
  - participantDisplayName string nullable
  - participantAvatarUrl string nullable
  - status string required
    
    One of: OPEN ARCHIVED
  - lastMessageAt string nullable date-time
  - lastActivityAt string required nullable date-time
  - lastMessagePreview string nullable
  - lastReadAt string nullable date-time
  - unreadCount number required
  - platformSeenAt string nullable date-time
  - createdAt string required nullable date-time
  - updatedAt string required nullable date-time
  - platformData object default {}
    
    3 fields
    
    canReply boolean nullable
    
    lastInboundAt string nullable date-time
    
    providerStateSync object nullable
    
    5 fields
    
    action string required
    
    One of: ARCHIVE OPEN
    
    status string required
    
    One of: SYNCED SYNC_FAILED UNSUPPORTED
    
    reason string nullable
    
    error string nullable
    
    syncedAt string nullable date-time
  - socialAccount object
    
    26 fields
    
    id string required
    
    type string required
    
    One of: TIKTOK YOUTUBE INSTAGRAM FACEBOOK TWITTER THREADS LINKEDIN PINTEREST REDDIT MASTODON DISCORD SLACK BLUESKY GOOGLE_BUSINESS SNAPCHAT
    
    teamId string required
    
    username string nullable
    
    displayName string nullable
    
    bio string nullable
    
    avatarUrl string nullable
    
    externalId string nullable
    
    providerPageId string nullable
    
    userUsername string nullable
    
    userDisplayName string nullable
    
    userEmail string nullable
    
    userId string nullable
    
    channels object[] nullable
    
    7 fields
    
    id string required
    
    name string nullable
    
    username string nullable
    
    address string nullable
    
    avatarUrl string nullable
    
    webhook object nullable
    
    4 fields
    
    id string nullable
    
    name string nullable
    
    avatar string nullable
    
    url string nullable
    
    metadata object nullable
    
    5 fields
    
    allowImages boolean nullable
    
    allowVideos boolean nullable
    
    allowGalleries boolean nullable
    
    linkFlairEnabled boolean nullable
    
    facebookPageId string nullable
    
    mastodonServerId string nullable
    
    instagramConnectionMethod string nullable
    
    One of: FACEBOOK INSTAGRAM
    
    twitterSubType string nullable
    
    One of: none basic premium premium_plus
    
    isTiktokBusinessAccount boolean nullable
    
    disconnectedCheckTryAt string nullable date-time
    
    deleteOn string nullable date-time
    
    messagingStatus string default "DISABLED"
    
    One of: DISABLED ENABLED DISABLE_PENDING
    
    messagingStatusUpdatedAt string nullable date-time
    
    messagingLastError string nullable
    
    createdAt string required nullable date-time
    
    updatedAt string required nullable date-time
    
    deletedAt string nullable date-time
- conversationMessage object nullable
  20 fields
  - id string required
  - conversationId string required
  - teamId string required
  - socialAccountId string required
  - platform string required
    
    One of: INSTAGRAM FACEBOOK
  - direction string required
    
    One of: INBOUND OUTBOUND
  - status string required
    
    One of: PENDING SENT DELIVERED SEEN FAILED
  - source string required
    
    One of: PRIVATE_REPLY DM WEBHOOK API ECHO
  - externalMessageId string nullable
  - text string nullable
  - attachments object[] default []
    
    8 fields
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE POST UNKNOWN
    
    url string nullable
    
    externalId string nullable
    
    mimeType string nullable
    
    name string nullable
    
    captionTrackUrl string nullable
    
    captionLanguage string nullable
    
    captionLabel string nullable
  - sentAt string nullable date-time
  - failedAt string nullable date-time
  - error string nullable
  - seenAt string nullable date-time
  - replyTo object nullable
    
    3 fields
    
    externalMessageId string nullable
    
    isSelfReply boolean nullable
    
    messageId string nullable
  - privateReplyContext object nullable
    
    10 fields
    
    fetchedCommentId string required
    
    externalCommentId string nullable
    
    text string nullable
    
    authorName string nullable
    
    authorAvatarUrl string nullable
    
    publishedAt string nullable date-time
    
    postId string nullable
    
    externalPostId string nullable
    
    postPermalink string nullable
    
    postThumbnailUrl string nullable
  - createdAt string required nullable date-time
  - updatedAt string required nullable date-time
  - platformData object default {}
    
    12 fields
    
    replyTo object nullable
    
    2 fields
    
    externalMessageId string nullable
    
    isSelfReply boolean nullable
    
    reactions object[]
    
    4 fields
    
    senderId string required
    
    reaction string nullable
    
    emoji string nullable
    
    reactedAt string nullable date-time
    
    quickReplies object[]
    
    3 fields
    
    id string min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[]
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object nullable
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUrl string nullable uri
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    isEcho boolean nullable
    
    isEdited boolean nullable
    
    editedAt string nullable date-time
    
    isPostback boolean nullable
    
    postbackPayload string nullable
    
    isUnsent boolean nullable
    
    unsentAt string nullable date-time
- fetchedComment object nullable
  23 fields
  - id string required
  - teamId string required
  - organizationId string nullable
  - postId string nullable
  - importedPostId string nullable
  - socialAccountId string required
  - importId string required
  - platform string required
    
    One of: FACEBOOK INSTAGRAM LINKEDIN YOUTUBE TIKTOK REDDIT THREADS MASTODON BLUESKY TWITTER
  - externalId string required
  - externalParentId string nullable
  - externalPostId string nullable
  - authorName string nullable
  - authorExternalId string nullable
  - authorProfileUrl string nullable
  - authorAvatarUrl string nullable
  - text string nullable
  - likesCount number required
  - repliesCount number required
  - platformData object default {}
    
    23 fields
    
    canDelete boolean nullable
    
    canHide boolean nullable
    
    canLike boolean nullable
    
    canModerate boolean nullable
    
    hidden boolean nullable
    
    likedByMe boolean nullable
    
    likedByAutomation boolean nullable
    
    reactionsCount number nullable
    
    reactionType string nullable
    
    One of: LIKE LOVE WOW HAHA SAD ANGRY
    
    owner boolean nullable
    
    hideStatus string nullable
    
    moderationStatus string nullable
    
    approvalStatus string nullable
    
    status string nullable
    
    attachmentType string nullable
    
    attachmentUrl string nullable
    
    cid string nullable
    
    origin string nullable
    
    One of: platform bundle
    
    source string nullable
    
    mediaProductType string nullable
    
    bundleCommentId string nullable
    
    displayState string nullable
    
    One of: active thread_deleted platform_missing
    
    disabledReason string nullable
  - publishedAt string nullable date-time
  - createdAt string required nullable date-time
  - updatedAt string required nullable date-time
  - deletedAt string nullable date-time
- socialAccount object
  26 fields
  - id string required
  - type string required
    
    One of: TIKTOK YOUTUBE INSTAGRAM FACEBOOK TWITTER THREADS LINKEDIN PINTEREST REDDIT MASTODON DISCORD SLACK BLUESKY GOOGLE_BUSINESS SNAPCHAT
  - teamId string required
  - username string nullable
  - displayName string nullable
  - bio string nullable
  - avatarUrl string nullable
  - externalId string nullable
  - providerPageId string nullable
  - userUsername string nullable
  - userDisplayName string nullable
  - userEmail string nullable
  - userId string nullable
  - channels object[] nullable
    
    7 fields
    
    id string required
    
    name string nullable
    
    username string nullable
    
    address string nullable
    
    avatarUrl string nullable
    
    webhook object nullable
    
    4 fields
    
    id string nullable
    
    name string nullable
    
    avatar string nullable
    
    url string nullable
    
    metadata object nullable
    
    5 fields
    
    allowImages boolean nullable
    
    allowVideos boolean nullable
    
    allowGalleries boolean nullable
    
    linkFlairEnabled boolean nullable
    
    facebookPageId string nullable
  - mastodonServerId string nullable
  - instagramConnectionMethod string nullable
    
    One of: FACEBOOK INSTAGRAM
  - twitterSubType string nullable
    
    One of: none basic premium premium_plus
  - isTiktokBusinessAccount boolean nullable
  - disconnectedCheckTryAt string nullable date-time
  - deleteOn string nullable date-time
  - messagingStatus string default "DISABLED"
    
    One of: DISABLED ENABLED DISABLE_PENDING
  - messagingStatusUpdatedAt string nullable date-time
  - messagingLastError string nullable
  - createdAt string required nullable date-time
  - updatedAt string required nullable date-time
  - deletedAt string nullable date-time
total number
nextCursor string nullable

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

GET /api/v1/automation-executions/{id}

Get an automation execution

automation.getExecution · requires x-api-key

Parameters

Name	In	Type	Notes
`id` required	path	`string`

Example

curl -X GET "https://api.siaran.my/api/v1/automation-executions/ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response `200`

29 top-level fields

id string required
teamId string required
organizationId string nullable
flowId string required
flowVersionId string required
triggerId string nullable
platform string required

One of: INSTAGRAM FACEBOOK TIKTOK
socialAccountId string required
conversationId string nullable
conversationMessageId string nullable
fetchedCommentId string nullable
senderExternalId string nullable
currentStepId string nullable
status string required

One of: QUEUED RUNNING COMPLETED FAILED CANCELED SKIPPED
idempotencyKey string required
input object default {}
11 fields
- type string nullable
  
  One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
- platform string nullable
  
  One of: INSTAGRAM FACEBOOK TIKTOK
- socialAccountId string nullable
- postId string nullable
- conversationId string nullable
- conversationMessageId string nullable
- fetchedCommentId string nullable
- senderExternalId string nullable
- externalMessageId string nullable
- text string nullable
- payload string nullable
output object default {}
error object nullable
3 fields
- code string nullable
- message string nullable
- retryable boolean nullable
startedAt string nullable date-time
completedAt string nullable date-time
createdAt string required nullable date-time
updatedAt string required nullable date-time
flow object
12 fields
- id string required
- teamId string required
- organizationId string nullable
- name string required
- status string required
  
  One of: DRAFT ACTIVE PAUSED ARCHIVED
- platformScope string required
  
  One of: INSTAGRAM FACEBOOK BOTH TIKTOK
- createdByUserId string nullable
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
- deletedAt string nullable date-time
- draftVersion object
  8 fields
  - id string required
  - flowId string required
  - version number required
  - status string required
    
    One of: DRAFT PUBLISHED RETIRED
  - definition object required
    
    2 fields
    
    trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
    
    steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
  - publishedAt string nullable date-time
  - publishedByUserId string nullable
  - createdAt string required nullable date-time
- publishedVersion object
  8 fields
  - id string required
  - flowId string required
  - version number required
  - status string required
    
    One of: DRAFT PUBLISHED RETIRED
  - definition object required
    
    2 fields
    
    trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
    
    steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
  - publishedAt string nullable date-time
  - publishedByUserId string nullable
  - createdAt string required nullable date-time
flowVersion object
8 fields
- id string required
- flowId string required
- version number required
- status string required
  
  One of: DRAFT PUBLISHED RETIRED
- definition object required
  2 fields
  - trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
  - steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
- publishedAt string nullable date-time
- publishedByUserId string nullable
- createdAt string required nullable date-time
steps object[]
12 fields
- id string required
- executionId string required
- stepId string nullable
- status string required
  
  One of: PENDING RUNNING COMPLETED FAILED SKIPPED
- attemptCount number required
- input object default {}
  11 fields
  - type string nullable
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
  - platform string nullable
    
    One of: INSTAGRAM FACEBOOK TIKTOK
  - socialAccountId string nullable
  - postId string nullable
  - conversationId string nullable
  - conversationMessageId string nullable
  - fetchedCommentId string nullable
  - senderExternalId string nullable
  - externalMessageId string nullable
  - text string nullable
  - payload string nullable
- output object default {}
- error object nullable
  3 fields
  - code string nullable
  - message string nullable
  - retryable boolean nullable
- startedAt string nullable date-time
- completedAt string nullable date-time
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
conversation object nullable
20 fields
- id string required
- teamId string required
- socialAccountId string required
- platform string required
  
  One of: INSTAGRAM FACEBOOK
- externalConversationId string nullable
- externalParticipantId string required
- participantUsername string nullable
- participantDisplayName string nullable
- participantAvatarUrl string nullable
- status string required
  
  One of: OPEN ARCHIVED
- lastMessageAt string nullable date-time
- lastActivityAt string required nullable date-time
- lastMessagePreview string nullable
- lastReadAt string nullable date-time
- unreadCount number required
- platformSeenAt string nullable date-time
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
- platformData object default {}
  3 fields
  - canReply boolean nullable
  - lastInboundAt string nullable date-time
  - providerStateSync object nullable
    
    5 fields
    
    action string required
    
    One of: ARCHIVE OPEN
    
    status string required
    
    One of: SYNCED SYNC_FAILED UNSUPPORTED
    
    reason string nullable
    
    error string nullable
    
    syncedAt string nullable date-time
- socialAccount object
  26 fields
  - id string required
  - type string required
    
    One of: TIKTOK YOUTUBE INSTAGRAM FACEBOOK TWITTER THREADS LINKEDIN PINTEREST REDDIT MASTODON DISCORD SLACK BLUESKY GOOGLE_BUSINESS SNAPCHAT
  - teamId string required
  - username string nullable
  - displayName string nullable
  - bio string nullable
  - avatarUrl string nullable
  - externalId string nullable
  - providerPageId string nullable
  - userUsername string nullable
  - userDisplayName string nullable
  - userEmail string nullable
  - userId string nullable
  - channels object[] nullable
    
    7 fields
    
    id string required
    
    name string nullable
    
    username string nullable
    
    address string nullable
    
    avatarUrl string nullable
    
    webhook object nullable
    
    4 fields
    
    id string nullable
    
    name string nullable
    
    avatar string nullable
    
    url string nullable
    
    metadata object nullable
    
    5 fields
    
    allowImages boolean nullable
    
    allowVideos boolean nullable
    
    allowGalleries boolean nullable
    
    linkFlairEnabled boolean nullable
    
    facebookPageId string nullable
  - mastodonServerId string nullable
  - instagramConnectionMethod string nullable
    
    One of: FACEBOOK INSTAGRAM
  - twitterSubType string nullable
    
    One of: none basic premium premium_plus
  - isTiktokBusinessAccount boolean nullable
  - disconnectedCheckTryAt string nullable date-time
  - deleteOn string nullable date-time
  - messagingStatus string default "DISABLED"
    
    One of: DISABLED ENABLED DISABLE_PENDING
  - messagingStatusUpdatedAt string nullable date-time
  - messagingLastError string nullable
  - createdAt string required nullable date-time
  - updatedAt string required nullable date-time
  - deletedAt string nullable date-time
conversationMessage object nullable
20 fields
- id string required
- conversationId string required
- teamId string required
- socialAccountId string required
- platform string required
  
  One of: INSTAGRAM FACEBOOK
- direction string required
  
  One of: INBOUND OUTBOUND
- status string required
  
  One of: PENDING SENT DELIVERED SEEN FAILED
- source string required
  
  One of: PRIVATE_REPLY DM WEBHOOK API ECHO
- externalMessageId string nullable
- text string nullable
- attachments object[] default []
  8 fields
  - type string required
    
    One of: IMAGE VIDEO AUDIO FILE POST UNKNOWN
  - url string nullable
  - externalId string nullable
  - mimeType string nullable
  - name string nullable
  - captionTrackUrl string nullable
  - captionLanguage string nullable
  - captionLabel string nullable
- sentAt string nullable date-time
- failedAt string nullable date-time
- error string nullable
- seenAt string nullable date-time
- replyTo object nullable
  3 fields
  - externalMessageId string nullable
  - isSelfReply boolean nullable
  - messageId string nullable
- privateReplyContext object nullable
  10 fields
  - fetchedCommentId string required
  - externalCommentId string nullable
  - text string nullable
  - authorName string nullable
  - authorAvatarUrl string nullable
  - publishedAt string nullable date-time
  - postId string nullable
  - externalPostId string nullable
  - postPermalink string nullable
  - postThumbnailUrl string nullable
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
- platformData object default {}
  12 fields
  - replyTo object nullable
    
    2 fields
    
    externalMessageId string nullable
    
    isSelfReply boolean nullable
  - reactions object[]
    
    4 fields
    
    senderId string required
    
    reaction string nullable
    
    emoji string nullable
    
    reactedAt string nullable date-time
  - quickReplies object[]
    
    3 fields
    
    id string min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
  - buttons object | object | object[]
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
  - carousel object nullable
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUrl string nullable uri
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
  - isEcho boolean nullable
  - isEdited boolean nullable
  - editedAt string nullable date-time
  - isPostback boolean nullable
  - postbackPayload string nullable
  - isUnsent boolean nullable
  - unsentAt string nullable date-time
fetchedComment object nullable
23 fields
- id string required
- teamId string required
- organizationId string nullable
- postId string nullable
- importedPostId string nullable
- socialAccountId string required
- importId string required
- platform string required
  
  One of: FACEBOOK INSTAGRAM LINKEDIN YOUTUBE TIKTOK REDDIT THREADS MASTODON BLUESKY TWITTER
- externalId string required
- externalParentId string nullable
- externalPostId string nullable
- authorName string nullable
- authorExternalId string nullable
- authorProfileUrl string nullable
- authorAvatarUrl string nullable
- text string nullable
- likesCount number required
- repliesCount number required
- platformData object default {}
  23 fields
  - canDelete boolean nullable
  - canHide boolean nullable
  - canLike boolean nullable
  - canModerate boolean nullable
  - hidden boolean nullable
  - likedByMe boolean nullable
  - likedByAutomation boolean nullable
  - reactionsCount number nullable
  - reactionType string nullable
    
    One of: LIKE LOVE WOW HAHA SAD ANGRY
  - owner boolean nullable
  - hideStatus string nullable
  - moderationStatus string nullable
  - approvalStatus string nullable
  - status string nullable
  - attachmentType string nullable
  - attachmentUrl string nullable
  - cid string nullable
  - origin string nullable
    
    One of: platform bundle
  - source string nullable
  - mediaProductType string nullable
  - bundleCommentId string nullable
  - displayState string nullable
    
    One of: active thread_deleted platform_missing
  - disabledReason string nullable
- publishedAt string nullable date-time
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
- deletedAt string nullable date-time
socialAccount object
26 fields
- id string required
- type string required
  
  One of: TIKTOK YOUTUBE INSTAGRAM FACEBOOK TWITTER THREADS LINKEDIN PINTEREST REDDIT MASTODON DISCORD SLACK BLUESKY GOOGLE_BUSINESS SNAPCHAT
- teamId string required
- username string nullable
- displayName string nullable
- bio string nullable
- avatarUrl string nullable
- externalId string nullable
- providerPageId string nullable
- userUsername string nullable
- userDisplayName string nullable
- userEmail string nullable
- userId string nullable
- channels object[] nullable
  7 fields
  - id string required
  - name string nullable
  - username string nullable
  - address string nullable
  - avatarUrl string nullable
  - webhook object nullable
    
    4 fields
    
    id string nullable
    
    name string nullable
    
    avatar string nullable
    
    url string nullable
  - metadata object nullable
    
    5 fields
    
    allowImages boolean nullable
    
    allowVideos boolean nullable
    
    allowGalleries boolean nullable
    
    linkFlairEnabled boolean nullable
    
    facebookPageId string nullable
- mastodonServerId string nullable
- instagramConnectionMethod string nullable
  
  One of: FACEBOOK INSTAGRAM
- twitterSubType string nullable
  
  One of: none basic premium premium_plus
- isTiktokBusinessAccount boolean nullable
- disconnectedCheckTryAt string nullable date-time
- deleteOn string nullable date-time
- messagingStatus string default "DISABLED"
  
  One of: DISABLED ENABLED DISABLE_PENDING
- messagingStatusUpdatedAt string nullable date-time
- messagingLastError string nullable
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
- deletedAt string nullable date-time

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

POST /api/v1/automations/{id}/test

Run an automation flow test

automation.testFlow · requires x-api-key

Parameters

Name	In	Type	Notes
`id` required	path	`string`

Request body `application/json`

input object default {}
11 fields
- type string nullable
  
  One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
- platform string nullable
  
  One of: INSTAGRAM FACEBOOK TIKTOK
- socialAccountId string nullable
- postId string nullable
- conversationId string nullable
- conversationMessageId string nullable
- fetchedCommentId string nullable
- senderExternalId string nullable
- externalMessageId string nullable
- text string nullable
- payload string nullable

Example

curl -X POST "https://api.siaran.my/api/v1/automations/ID/test" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "input": {}
  }'

Response `200`

29 top-level fields

id string required
teamId string required
organizationId string nullable
flowId string required
flowVersionId string required
triggerId string nullable
platform string required

One of: INSTAGRAM FACEBOOK TIKTOK
socialAccountId string required
conversationId string nullable
conversationMessageId string nullable
fetchedCommentId string nullable
senderExternalId string nullable
currentStepId string nullable
status string required

One of: QUEUED RUNNING COMPLETED FAILED CANCELED SKIPPED
idempotencyKey string required
input object default {}
11 fields
- type string nullable
  
  One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
- platform string nullable
  
  One of: INSTAGRAM FACEBOOK TIKTOK
- socialAccountId string nullable
- postId string nullable
- conversationId string nullable
- conversationMessageId string nullable
- fetchedCommentId string nullable
- senderExternalId string nullable
- externalMessageId string nullable
- text string nullable
- payload string nullable
output object default {}
error object nullable
3 fields
- code string nullable
- message string nullable
- retryable boolean nullable
startedAt string nullable date-time
completedAt string nullable date-time
createdAt string required nullable date-time
updatedAt string required nullable date-time
flow object
12 fields
- id string required
- teamId string required
- organizationId string nullable
- name string required
- status string required
  
  One of: DRAFT ACTIVE PAUSED ARCHIVED
- platformScope string required
  
  One of: INSTAGRAM FACEBOOK BOTH TIKTOK
- createdByUserId string nullable
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
- deletedAt string nullable date-time
- draftVersion object
  8 fields
  - id string required
  - flowId string required
  - version number required
  - status string required
    
    One of: DRAFT PUBLISHED RETIRED
  - definition object required
    
    2 fields
    
    trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
    
    steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
  - publishedAt string nullable date-time
  - publishedByUserId string nullable
  - createdAt string required nullable date-time
- publishedVersion object
  8 fields
  - id string required
  - flowId string required
  - version number required
  - status string required
    
    One of: DRAFT PUBLISHED RETIRED
  - definition object required
    
    2 fields
    
    trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
    
    steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
  - publishedAt string nullable date-time
  - publishedByUserId string nullable
  - createdAt string required nullable date-time
flowVersion object
8 fields
- id string required
- flowId string required
- version number required
- status string required
  
  One of: DRAFT PUBLISHED RETIRED
- definition object required
  2 fields
  - trigger object required
    
    11 fields
    
    keywords string[] max 100 itemseach: min length 1each: max length 200
    
    matchMode string default "ANY"
    
    One of: ANY ALL
    
    caseSensitive boolean default false
    
    senderExternalIds string[] max 100 itemseach: min length 1each: max length 64
    
    payloads string[] max 100 itemseach: min length 1each: max length 1,000
    
    actionDelaySeconds integer default 0 ≥ 0≤ 86400
    
    id string min length 1max length 36
    
    type string required
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
    
    platform string required
    
    One of: INSTAGRAM FACEBOOK TIKTOK
    
    socialAccountId string required
    
    postId string nullable
  - steps object | object | object | object | object | object | object[] required
    
    One of 7 shapes
    
    type = CONDITION
    
    id string min length 1max length 36
    
    type string required
    
    One of: CONDITION
    
    conditions object[] required min 1 items
    
    5 fields
    
    id string min length 1max length 36
    
    field string required
    
    One of: TEXT PAYLOAD PLATFORM SENDER_ID
    
    operator string required
    
    One of: CONTAINS EQUALS MATCHES_ANY
    
    value string required min length 1max length 1,000
    
    caseSensitive boolean default false
    
    type = SEND_MESSAGE
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_MESSAGE
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PRIVATE_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PRIVATE_REPLY
    
    message object required
    
    5 fields
    
    text string max length 1,000
    
    attachments object[] max 10 items
    
    2 fields
    
    uploadId string required min length 1
    
    type string required
    
    One of: IMAGE VIDEO AUDIO FILE
    
    quickReplies object[] max 13 items
    
    3 fields
    
    id string required min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    carousel object
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
    
    type = SEND_PUBLIC_COMMENT_REPLY
    
    id string min length 1max length 36
    
    type string required
    
    One of: SEND_PUBLIC_COMMENT_REPLY
    
    text string required min length 1max length 1,000
    
    type = LIKE_COMMENT
    
    id string min length 1max length 36
    
    type string required
    
    One of: LIKE_COMMENT
    
    type = ARCHIVE_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: ARCHIVE_CONVERSATION
    
    type = OPEN_CONVERSATION
    
    id string min length 1max length 36
    
    type string required
    
    One of: OPEN_CONVERSATION
- publishedAt string nullable date-time
- publishedByUserId string nullable
- createdAt string required nullable date-time
steps object[]
12 fields
- id string required
- executionId string required
- stepId string nullable
- status string required
  
  One of: PENDING RUNNING COMPLETED FAILED SKIPPED
- attemptCount number required
- input object default {}
  11 fields
  - type string nullable
    
    One of: COMMENT_CREATED DM_RECEIVED QUICK_REPLY_CLICKED BUTTON_CLICKED MANUAL_TEST
  - platform string nullable
    
    One of: INSTAGRAM FACEBOOK TIKTOK
  - socialAccountId string nullable
  - postId string nullable
  - conversationId string nullable
  - conversationMessageId string nullable
  - fetchedCommentId string nullable
  - senderExternalId string nullable
  - externalMessageId string nullable
  - text string nullable
  - payload string nullable
- output object default {}
- error object nullable
  3 fields
  - code string nullable
  - message string nullable
  - retryable boolean nullable
- startedAt string nullable date-time
- completedAt string nullable date-time
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
conversation object nullable
20 fields
- id string required
- teamId string required
- socialAccountId string required
- platform string required
  
  One of: INSTAGRAM FACEBOOK
- externalConversationId string nullable
- externalParticipantId string required
- participantUsername string nullable
- participantDisplayName string nullable
- participantAvatarUrl string nullable
- status string required
  
  One of: OPEN ARCHIVED
- lastMessageAt string nullable date-time
- lastActivityAt string required nullable date-time
- lastMessagePreview string nullable
- lastReadAt string nullable date-time
- unreadCount number required
- platformSeenAt string nullable date-time
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
- platformData object default {}
  3 fields
  - canReply boolean nullable
  - lastInboundAt string nullable date-time
  - providerStateSync object nullable
    
    5 fields
    
    action string required
    
    One of: ARCHIVE OPEN
    
    status string required
    
    One of: SYNCED SYNC_FAILED UNSUPPORTED
    
    reason string nullable
    
    error string nullable
    
    syncedAt string nullable date-time
- socialAccount object
  26 fields
  - id string required
  - type string required
    
    One of: TIKTOK YOUTUBE INSTAGRAM FACEBOOK TWITTER THREADS LINKEDIN PINTEREST REDDIT MASTODON DISCORD SLACK BLUESKY GOOGLE_BUSINESS SNAPCHAT
  - teamId string required
  - username string nullable
  - displayName string nullable
  - bio string nullable
  - avatarUrl string nullable
  - externalId string nullable
  - providerPageId string nullable
  - userUsername string nullable
  - userDisplayName string nullable
  - userEmail string nullable
  - userId string nullable
  - channels object[] nullable
    
    7 fields
    
    id string required
    
    name string nullable
    
    username string nullable
    
    address string nullable
    
    avatarUrl string nullable
    
    webhook object nullable
    
    4 fields
    
    id string nullable
    
    name string nullable
    
    avatar string nullable
    
    url string nullable
    
    metadata object nullable
    
    5 fields
    
    allowImages boolean nullable
    
    allowVideos boolean nullable
    
    allowGalleries boolean nullable
    
    linkFlairEnabled boolean nullable
    
    facebookPageId string nullable
  - mastodonServerId string nullable
  - instagramConnectionMethod string nullable
    
    One of: FACEBOOK INSTAGRAM
  - twitterSubType string nullable
    
    One of: none basic premium premium_plus
  - isTiktokBusinessAccount boolean nullable
  - disconnectedCheckTryAt string nullable date-time
  - deleteOn string nullable date-time
  - messagingStatus string default "DISABLED"
    
    One of: DISABLED ENABLED DISABLE_PENDING
  - messagingStatusUpdatedAt string nullable date-time
  - messagingLastError string nullable
  - createdAt string required nullable date-time
  - updatedAt string required nullable date-time
  - deletedAt string nullable date-time
conversationMessage object nullable
20 fields
- id string required
- conversationId string required
- teamId string required
- socialAccountId string required
- platform string required
  
  One of: INSTAGRAM FACEBOOK
- direction string required
  
  One of: INBOUND OUTBOUND
- status string required
  
  One of: PENDING SENT DELIVERED SEEN FAILED
- source string required
  
  One of: PRIVATE_REPLY DM WEBHOOK API ECHO
- externalMessageId string nullable
- text string nullable
- attachments object[] default []
  8 fields
  - type string required
    
    One of: IMAGE VIDEO AUDIO FILE POST UNKNOWN
  - url string nullable
  - externalId string nullable
  - mimeType string nullable
  - name string nullable
  - captionTrackUrl string nullable
  - captionLanguage string nullable
  - captionLabel string nullable
- sentAt string nullable date-time
- failedAt string nullable date-time
- error string nullable
- seenAt string nullable date-time
- replyTo object nullable
  3 fields
  - externalMessageId string nullable
  - isSelfReply boolean nullable
  - messageId string nullable
- privateReplyContext object nullable
  10 fields
  - fetchedCommentId string required
  - externalCommentId string nullable
  - text string nullable
  - authorName string nullable
  - authorAvatarUrl string nullable
  - publishedAt string nullable date-time
  - postId string nullable
  - externalPostId string nullable
  - postPermalink string nullable
  - postThumbnailUrl string nullable
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
- platformData object default {}
  12 fields
  - replyTo object nullable
    
    2 fields
    
    externalMessageId string nullable
    
    isSelfReply boolean nullable
  - reactions object[]
    
    4 fields
    
    senderId string required
    
    reaction string nullable
    
    emoji string nullable
    
    reactedAt string nullable date-time
  - quickReplies object[]
    
    3 fields
    
    id string min length 1max length 36
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
  - buttons object | object | object[]
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
  - carousel object nullable
    
    1 field
    
    cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUrl string nullable uri
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30
  - isEcho boolean nullable
  - isEdited boolean nullable
  - editedAt string nullable date-time
  - isPostback boolean nullable
  - postbackPayload string nullable
  - isUnsent boolean nullable
  - unsentAt string nullable date-time
fetchedComment object nullable
23 fields
- id string required
- teamId string required
- organizationId string nullable
- postId string nullable
- importedPostId string nullable
- socialAccountId string required
- importId string required
- platform string required
  
  One of: FACEBOOK INSTAGRAM LINKEDIN YOUTUBE TIKTOK REDDIT THREADS MASTODON BLUESKY TWITTER
- externalId string required
- externalParentId string nullable
- externalPostId string nullable
- authorName string nullable
- authorExternalId string nullable
- authorProfileUrl string nullable
- authorAvatarUrl string nullable
- text string nullable
- likesCount number required
- repliesCount number required
- platformData object default {}
  23 fields
  - canDelete boolean nullable
  - canHide boolean nullable
  - canLike boolean nullable
  - canModerate boolean nullable
  - hidden boolean nullable
  - likedByMe boolean nullable
  - likedByAutomation boolean nullable
  - reactionsCount number nullable
  - reactionType string nullable
    
    One of: LIKE LOVE WOW HAHA SAD ANGRY
  - owner boolean nullable
  - hideStatus string nullable
  - moderationStatus string nullable
  - approvalStatus string nullable
  - status string nullable
  - attachmentType string nullable
  - attachmentUrl string nullable
  - cid string nullable
  - origin string nullable
    
    One of: platform bundle
  - source string nullable
  - mediaProductType string nullable
  - bundleCommentId string nullable
  - displayState string nullable
    
    One of: active thread_deleted platform_missing
  - disabledReason string nullable
- publishedAt string nullable date-time
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
- deletedAt string nullable date-time
socialAccount object
26 fields
- id string required
- type string required
  
  One of: TIKTOK YOUTUBE INSTAGRAM FACEBOOK TWITTER THREADS LINKEDIN PINTEREST REDDIT MASTODON DISCORD SLACK BLUESKY GOOGLE_BUSINESS SNAPCHAT
- teamId string required
- username string nullable
- displayName string nullable
- bio string nullable
- avatarUrl string nullable
- externalId string nullable
- providerPageId string nullable
- userUsername string nullable
- userDisplayName string nullable
- userEmail string nullable
- userId string nullable
- channels object[] nullable
  7 fields
  - id string required
  - name string nullable
  - username string nullable
  - address string nullable
  - avatarUrl string nullable
  - webhook object nullable
    
    4 fields
    
    id string nullable
    
    name string nullable
    
    avatar string nullable
    
    url string nullable
  - metadata object nullable
    
    5 fields
    
    allowImages boolean nullable
    
    allowVideos boolean nullable
    
    allowGalleries boolean nullable
    
    linkFlairEnabled boolean nullable
    
    facebookPageId string nullable
- mastodonServerId string nullable
- instagramConnectionMethod string nullable
  
  One of: FACEBOOK INSTAGRAM
- twitterSubType string nullable
  
  One of: none basic premium premium_plus
- isTiktokBusinessAccount boolean nullable
- disconnectedCheckTryAt string nullable date-time
- deleteOn string nullable date-time
- messagingStatus string default "DISABLED"
  
  One of: DISABLED ENABLED DISABLE_PENDING
- messagingStatusUpdatedAt string nullable date-time
- messagingLastError string nullable
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
- deletedAt string nullable date-time

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error · 503 Unavailable

GET /api/v1/automation-provider-settings

Get automation provider settings

automation.getProviderSettings · requires x-api-key

Parameters

Name	In	Type	Notes
`teamId` required	query	`string`
`platform`	query	`string`	One of INSTAGRAM, FACEBOOK, TIKTOK
`socialAccountId`	query	`string`
`type`	query	`string`	One of FACEBOOK_PERSISTENT_MENU, INSTAGRAM_ICE_BREAKERS
`status`	query	`string`	One of DRAFT, SYNCED, SYNC_FAILED, DISABLED
`offset`	query	`number`	default 0 · nullable
`limit`	query	`number`	default 10 · nullable

Example

curl -X GET "https://api.siaran.my/api/v1/automation-provider-settings?teamId=TEAM_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response `200`

2 top-level fields

items object[] required
14 fields
- id string required
- teamId string required
- organizationId string nullable
- platform string required
  
  One of: INSTAGRAM FACEBOOK TIKTOK
- socialAccountId string required
- type string required
  
  One of: FACEBOOK_PERSISTENT_MENU INSTAGRAM_ICE_BREAKERS
- status string required
  
  One of: DRAFT SYNCED SYNC_FAILED DISABLED
- config object | object default {}
  One of 2 shapes
  Variant 1
  
  getStartedPayload string min length 1max length 1,000
  
  composerInputDisabled boolean
  
  items object | object[] max 3 items
  
  One of 2 shapes
  
  type = POSTBACK
  
  title string required min length 1
  
  type string required
  
  One of: POSTBACK
  
  payload string required min length 1max length 1,000
  
  url string
  
  type = URL
  
  title string required min length 1
  
  type string required
  
  One of: URL
  
  payload string
  
  url string required uri
  Variant 2
  
  iceBreakers object[] max 4 items
  
  2 fields
  
  question string required min length 1
  
  payload string required min length 1max length 1,000
- providerResponse object nullable
- lastSyncedAt string nullable date-time
- lastSyncError object nullable
  3 fields
  - code string nullable
  - message string nullable
  - retryable boolean nullable
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
- socialAccount object
  26 fields
  - id string required
  - type string required
    
    One of: TIKTOK YOUTUBE INSTAGRAM FACEBOOK TWITTER THREADS LINKEDIN PINTEREST REDDIT MASTODON DISCORD SLACK BLUESKY GOOGLE_BUSINESS SNAPCHAT
  - teamId string required
  - username string nullable
  - displayName string nullable
  - bio string nullable
  - avatarUrl string nullable
  - externalId string nullable
  - providerPageId string nullable
  - userUsername string nullable
  - userDisplayName string nullable
  - userEmail string nullable
  - userId string nullable
  - channels object[] nullable
    
    7 fields
    
    id string required
    
    name string nullable
    
    username string nullable
    
    address string nullable
    
    avatarUrl string nullable
    
    webhook object nullable
    
    4 fields
    
    id string nullable
    
    name string nullable
    
    avatar string nullable
    
    url string nullable
    
    metadata object nullable
    
    5 fields
    
    allowImages boolean nullable
    
    allowVideos boolean nullable
    
    allowGalleries boolean nullable
    
    linkFlairEnabled boolean nullable
    
    facebookPageId string nullable
  - mastodonServerId string nullable
  - instagramConnectionMethod string nullable
    
    One of: FACEBOOK INSTAGRAM
  - twitterSubType string nullable
    
    One of: none basic premium premium_plus
  - isTiktokBusinessAccount boolean nullable
  - disconnectedCheckTryAt string nullable date-time
  - deleteOn string nullable date-time
  - messagingStatus string default "DISABLED"
    
    One of: DISABLED ENABLED DISABLE_PENDING
  - messagingStatusUpdatedAt string nullable date-time
  - messagingLastError string nullable
  - createdAt string required nullable date-time
  - updatedAt string required nullable date-time
  - deletedAt string nullable date-time
total number required

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

PUT /api/v1/automation-provider-settings/{socialAccountId}/{type}

Create or update automation provider settings

automation.upsertProviderSetting · requires x-api-key

Parameters

Name	In	Type	Notes
`socialAccountId` required	path	`string`
`type` required	path	`string`	One of FACEBOOK_PERSISTENT_MENU, INSTAGRAM_ICE_BREAKERS

Request body `application/json`

teamId string required
platform string required

One of: INSTAGRAM FACEBOOK TIKTOK
config object | object default {}
One of 2 shapes
Variant 1
- getStartedPayload string min length 1max length 1,000
- composerInputDisabled boolean
- items object | object[] max 3 items
  One of 2 shapes
  
  type = POSTBACK
  
  title string required min length 1
  
  type string required
  
  One of: POSTBACK
  
  payload string required min length 1max length 1,000
  
  url string
  
  type = URL
  
  title string required min length 1
  
  type string required
  
  One of: URL
  
  payload string
  
  url string required uri
Variant 2
- iceBreakers object[] max 4 items
  2 fields
  
  question string required min length 1
  
  payload string required min length 1max length 1,000
status string default "DRAFT"

One of: DRAFT DISABLED

Example

curl -X PUT "https://api.siaran.my/api/v1/automation-provider-settings/SOCIALACCOUNTID/TYPE" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "teamId": "TEAM_ID",
    "platform": "INSTAGRAM"
  }'

Response `200`

14 top-level fields

id string required
teamId string required
organizationId string nullable
platform string required

One of: INSTAGRAM FACEBOOK TIKTOK
socialAccountId string required
type string required

One of: FACEBOOK_PERSISTENT_MENU INSTAGRAM_ICE_BREAKERS
status string required

One of: DRAFT SYNCED SYNC_FAILED DISABLED
config object | object default {}
One of 2 shapes
Variant 1
- getStartedPayload string min length 1max length 1,000
- composerInputDisabled boolean
- items object | object[] max 3 items
  One of 2 shapes
  
  type = POSTBACK
  
  title string required min length 1
  
  type string required
  
  One of: POSTBACK
  
  payload string required min length 1max length 1,000
  
  url string
  
  type = URL
  
  title string required min length 1
  
  type string required
  
  One of: URL
  
  payload string
  
  url string required uri
Variant 2
- iceBreakers object[] max 4 items
  2 fields
  
  question string required min length 1
  
  payload string required min length 1max length 1,000
providerResponse object nullable
lastSyncedAt string nullable date-time
lastSyncError object nullable
3 fields
- code string nullable
- message string nullable
- retryable boolean nullable
createdAt string required nullable date-time
updatedAt string required nullable date-time
socialAccount object
26 fields
- id string required
- type string required
  
  One of: TIKTOK YOUTUBE INSTAGRAM FACEBOOK TWITTER THREADS LINKEDIN PINTEREST REDDIT MASTODON DISCORD SLACK BLUESKY GOOGLE_BUSINESS SNAPCHAT
- teamId string required
- username string nullable
- displayName string nullable
- bio string nullable
- avatarUrl string nullable
- externalId string nullable
- providerPageId string nullable
- userUsername string nullable
- userDisplayName string nullable
- userEmail string nullable
- userId string nullable
- channels object[] nullable
  7 fields
  - id string required
  - name string nullable
  - username string nullable
  - address string nullable
  - avatarUrl string nullable
  - webhook object nullable
    
    4 fields
    
    id string nullable
    
    name string nullable
    
    avatar string nullable
    
    url string nullable
  - metadata object nullable
    
    5 fields
    
    allowImages boolean nullable
    
    allowVideos boolean nullable
    
    allowGalleries boolean nullable
    
    linkFlairEnabled boolean nullable
    
    facebookPageId string nullable
- mastodonServerId string nullable
- instagramConnectionMethod string nullable
  
  One of: FACEBOOK INSTAGRAM
- twitterSubType string nullable
  
  One of: none basic premium premium_plus
- isTiktokBusinessAccount boolean nullable
- disconnectedCheckTryAt string nullable date-time
- deleteOn string nullable date-time
- messagingStatus string default "DISABLED"
  
  One of: DISABLED ENABLED DISABLE_PENDING
- messagingStatusUpdatedAt string nullable date-time
- messagingLastError string nullable
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
- deletedAt string nullable date-time

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

POST /api/v1/automation-provider-settings/{id}/sync

Sync automation provider settings

automation.syncProviderSetting · requires x-api-key

Parameters

Name	In	Type	Notes
`id` required	path	`string`

Example

curl -X POST "https://api.siaran.my/api/v1/automation-provider-settings/ID/sync" \
  -H "x-api-key: $SIAR_API_KEY"

Response `200`

14 top-level fields

id string required
teamId string required
organizationId string nullable
platform string required

One of: INSTAGRAM FACEBOOK TIKTOK
socialAccountId string required
type string required

One of: FACEBOOK_PERSISTENT_MENU INSTAGRAM_ICE_BREAKERS
status string required

One of: DRAFT SYNCED SYNC_FAILED DISABLED
config object | object default {}
One of 2 shapes
Variant 1
- getStartedPayload string min length 1max length 1,000
- composerInputDisabled boolean
- items object | object[] max 3 items
  One of 2 shapes
  
  type = POSTBACK
  
  title string required min length 1
  
  type string required
  
  One of: POSTBACK
  
  payload string required min length 1max length 1,000
  
  url string
  
  type = URL
  
  title string required min length 1
  
  type string required
  
  One of: URL
  
  payload string
  
  url string required uri
Variant 2
- iceBreakers object[] max 4 items
  2 fields
  
  question string required min length 1
  
  payload string required min length 1max length 1,000
providerResponse object nullable
lastSyncedAt string nullable date-time
lastSyncError object nullable
3 fields
- code string nullable
- message string nullable
- retryable boolean nullable
createdAt string required nullable date-time
updatedAt string required nullable date-time
socialAccount object
26 fields
- id string required
- type string required
  
  One of: TIKTOK YOUTUBE INSTAGRAM FACEBOOK TWITTER THREADS LINKEDIN PINTEREST REDDIT MASTODON DISCORD SLACK BLUESKY GOOGLE_BUSINESS SNAPCHAT
- teamId string required
- username string nullable
- displayName string nullable
- bio string nullable
- avatarUrl string nullable
- externalId string nullable
- providerPageId string nullable
- userUsername string nullable
- userDisplayName string nullable
- userEmail string nullable
- userId string nullable
- channels object[] nullable
  7 fields
  - id string required
  - name string nullable
  - username string nullable
  - address string nullable
  - avatarUrl string nullable
  - webhook object nullable
    
    4 fields
    
    id string nullable
    
    name string nullable
    
    avatar string nullable
    
    url string nullable
  - metadata object nullable
    
    5 fields
    
    allowImages boolean nullable
    
    allowVideos boolean nullable
    
    allowGalleries boolean nullable
    
    linkFlairEnabled boolean nullable
    
    facebookPageId string nullable
- mastodonServerId string nullable
- instagramConnectionMethod string nullable
  
  One of: FACEBOOK INSTAGRAM
- twitterSubType string nullable
  
  One of: none basic premium premium_plus
- isTiktokBusinessAccount boolean nullable
- disconnectedCheckTryAt string nullable date-time
- deleteOn string nullable date-time
- messagingStatus string default "DISABLED"
  
  One of: DISABLED ENABLED DISABLE_PENDING
- messagingStatusUpdatedAt string nullable date-time
- messagingLastError string nullable
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
- deletedAt string nullable date-time

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

POST /api/v1/automation-rich-messages/conversations/{conversationId}

Send a rich automation message to a conversation

automation.sendRichMessage · requires x-api-key

Parameters

Name	In	Type	Notes
`conversationId` required	path	`string`

Request body `application/json`

teamId string
message object required
5 fields
- text string max length 1,000
- attachments object[] max 10 items
  2 fields
  - uploadId string required min length 1
  - type string required
    
    One of: IMAGE VIDEO AUDIO FILE
- quickReplies object[] max 13 items
  3 fields
  - id string required min length 1max length 36
  - label string required min length 1max length 20
  - payload string required min length 1max length 1,000
- buttons object | object | object[] max 3 items
  One of 3 shapes
  type = POSTBACK
  
  id string required min length 1max length 36
  
  type string required
  
  One of: POSTBACK
  
  label string required min length 1max length 20
  
  payload string required min length 1max length 1,000
  type = URL
  
  id string required min length 1max length 36
  
  type string required
  
  One of: URL
  
  label string required min length 1max length 20
  
  url string required uri
  type = PHONE
  
  id string required min length 1max length 36
  
  type string required
  
  One of: PHONE
  
  label string required min length 1max length 20
  
  phoneNumber string required min length 3max length 30
- carousel object
  1 field
  - cards object[] required min 1 itemsmax 10 items
    
    5 fields
    
    id string required min length 1max length 36
    
    title string required min length 1max length 80
    
    subtitle string nullable max length 80
    
    imageUploadId string nullable min length 1
    
    buttons object | object | object[] max 3 items
    
    One of 3 shapes
    
    type = POSTBACK
    
    id string required min length 1max length 36
    
    type string required
    
    One of: POSTBACK
    
    label string required min length 1max length 20
    
    payload string required min length 1max length 1,000
    
    type = URL
    
    id string required min length 1max length 36
    
    type string required
    
    One of: URL
    
    label string required min length 1max length 20
    
    url string required uri
    
    type = PHONE
    
    id string required min length 1max length 36
    
    type string required
    
    One of: PHONE
    
    label string required min length 1max length 20
    
    phoneNumber string required min length 3max length 30

Example

curl -X POST "https://api.siaran.my/api/v1/automation-rich-messages/conversations/CONVERSATIONID" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "message": {}
  }'

Response `200`

3 top-level fields

conversationId string required
messageId string nullable
externalMessageId string nullable

Automations API

Parameters

Example

Response 200

Request body application/json

Example

Response 201

Request body application/json

Example

Response 201

Parameters

Example

Response 200

Parameters

Request body application/json

Example

Response 200

Parameters

Example

Response 200

Parameters

Request body application/json

Example

Response 200

Parameters

Example

Response 200

Parameters

Example

Response 200

Parameters

Example

Response 200

Parameters

Example

Response 200

Parameters

Example

Response 200

Parameters

Request body application/json

Example

Response 200

Parameters

Example

Response 200

Parameters

Request body application/json

Example

Response 200

Parameters

Example

Response 200

Parameters

Request body application/json

Example

Response 200

Response `200`

Request body `application/json`

Response `201`

Request body `application/json`

Response `201`

Response `200`

Request body `application/json`

Response `200`

Response `200`

Request body `application/json`

Response `200`

Response `200`

Response `200`

Response `200`

Response `200`

Response `200`

Request body `application/json`

Response `200`

Response `200`

Request body `application/json`

Response `200`

Response `200`

Request body `application/json`

Response `200`