rizamodocs
Comment automations

Test a comment automation

POST
/comment-automations/{id}/test

Whether a comment with this text would trigger it, and the messages it would send, with their Rizamo links: each as its text and its button (the link, or the follow gate's reply button). Nothing is sent or recorded. Whether the person already got it, follows the account or is within Meta's windows is only known for real comments.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the web app, under Developers. It starts with rz_live_.

Path Parameters

id*string

The comment automation's id (cauto_).

Lengthlength <= 100

Header Parameters

Idempotency-Key?string

1 to 255 printable characters, new for each request (a UUID); the body up to 1 MB. For 24 hours a repeat with the same key, path and body gets the first answer, with Idempotent-Replayed: true, instead of running again; 5xx, 409 and 429 answers are not kept. Errors, Retries, has the rest.

Length1 <= length <= 255

Request Body

application/json
  1. body
text*string

A sample comment.

Lengthlength <= 2200

Response Body

OK

application/json
  1. response
triggers*boolean
reason*string

Why it would or would not answer, in a sentence.

keyword*|

The keyword that matched.

privateReply*|

The first private reply, as it would go out: the message with its Rizamo links, or the follow gate's ask.

afterFollow*|

Follow gate: the message sent once they reply as a follower.

reminder*|

Follow gate: sent once if they reply without following.

publicReplies*array<string>

One of these is posted under the comment, at random, after the private reply.

markDone*boolean
Example Request
curl -X POST 'https://api.rizamo.com/v1/comment-automations/cauto_01m4h40hg0f4wa1w5cfcgpjrp3/test' \  -H 'Idempotency-Key: 4b9e7c1a-2f3d-4e8a-9c6b-1d2e3f4a5b6c' \  -H 'Content-Type: application/json' \  -d '{  "text": "Menu please!"}'
Example Response
{  "triggers": true,  "reason": "It has the keyword menu, as a whole word.",  "keyword": "menu",  "privateReply": {    "text": "Here is our winter menu, with every drink and pastry of the season.",    "button": {      "title": "See the menu",      "url": "https://go.rizamo.com/w2Lp9d"    }  },  "afterFollow": null,  "reminder": null,  "publicReplies": [    "Sent it to your messages!",    "Check your DMs!"  ],  "markDone": true}