Skip to navigation
API ReferenceInstagram Automation

Get a rule

Returns one rule.

Authentication

AuthorizationBearer

Your API key, issued by ParsChat sales. One key per account, spanning every robot you own. Send it as Authorization: Bearer pk_live_….

Path parameters

robot_idstringRequired
The robot's id, as returned by the create call.
channel_idstringRequired
The channel's id.
rule_idstringRequired
The rule's id.

Response

The rule.
idstringOptional
ParsChat identifier for the rule.
namestringOptional
Your label for the rule. Shown in the panel.
triggerobjectOptional
What makes a rule fire.
actionslist of objectsOptional
What to send on a DM rule.
reply_in_commentobjectOptional
Comment rules only. Posts a public reply under the comment.
then_send_dmlist of objectsOptional
Comment rules only. Follows the public reply with a private message.
require_followobjectOptional

Withhold the reply until the commenter follows the page. The verification round-trip is ours: you do not implement it.

is_activebooleanOptionalDefaults to true
Whether the rule is currently firing.
created_atdatetimeOptional
When the rule was created.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error