Skip to content

CommentAutomationsApi.md

Latest commit

 

History

History
192 lines (107 loc) · 6.45 KB

CommentAutomationsApi.md

File metadata and controls

192 lines (107 loc) · 6.45 KB

\CommentAutomationsApi

All URIs are relative to https://zernio.com/api

Method HTTP request Description
create_comment_automation POST /v1/comment-automations Create a comment-to-DM automation
delete_comment_automation DELETE /v1/comment-automations/{automationId} Delete automation and all logs
get_comment_automation GET /v1/comment-automations/{automationId} Get automation details with recent logs
list_comment_automation_logs GET /v1/comment-automations/{automationId}/logs List trigger logs for an automation
list_comment_automations GET /v1/comment-automations List comment-to-DM automations
update_comment_automation PATCH /v1/comment-automations/{automationId} Update automation settings

create_comment_automation

models::CreateCommentAutomation200Response create_comment_automation(create_comment_automation_request) Create a comment-to-DM automation

Create a keyword-triggered DM automation on an Instagram or Facebook post. When someone comments a matching keyword, they automatically receive a DM. Only one active automation per post is allowed.

Parameters

Name Type Description Required Notes
create_comment_automation_request CreateCommentAutomationRequest [required]

Return type

models::CreateCommentAutomation200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_comment_automation

delete_comment_automation(automation_id) Delete automation and all logs

Parameters

Name Type Description Required Notes
automation_id String [required]

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_comment_automation

models::GetCommentAutomation200Response get_comment_automation(automation_id) Get automation details with recent logs

Parameters

Name Type Description Required Notes
automation_id String [required]

Return type

models::GetCommentAutomation200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_comment_automation_logs

models::ListCommentAutomationLogs200Response list_comment_automation_logs(automation_id, status, limit, skip) List trigger logs for an automation

Paginated list of every comment that triggered this automation, with send status and commenter info.

Parameters

Name Type Description Required Notes
automation_id String [required]
status Option<String> Filter by result status
limit Option<i32> [default to 50]
skip Option<i32> [default to 0]

Return type

models::ListCommentAutomationLogs200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_comment_automations

models::ListCommentAutomations200Response list_comment_automations(profile_id) List comment-to-DM automations

List all comment-to-DM automations for a profile. Returns automations with their stats.

Parameters

Name Type Description Required Notes
profile_id Option<String> Filter by profile. Omit to list across all profiles

Return type

models::ListCommentAutomations200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_comment_automation

models::UpdateCommentAutomation200Response update_comment_automation(automation_id, update_comment_automation_request) Update automation settings

Parameters

Name Type Description Required Notes
automation_id String [required]
update_comment_automation_request Option<UpdateCommentAutomationRequest>

Return type

models::UpdateCommentAutomation200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]