Automations

Update an automation

Change any subset of an automation's settings — for example flip active, adjust dailyCap, or turn clickTracking off. Only the fields you send are modified.

patch/api/v1/automations/{id}

Request

  • Base URL: https://replyatlas.com
  • URL: https://replyatlas.com/api/v1/automations/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

namestring

A label for this automation (shown in your dashboard).

igAccountIdstring

The connected Instagram account this automation runs on. List IDs via GET /api/v1/ig-accounts.

triggerType'COMMENT' | 'STORY_REPLY' | 'LIVE_COMMENT' | 'AD_REFERRAL' | 'POSTBACK' | 'MENTION' | 'DM_KEYWORD'

What fires the DM. COMMENT = a comment on your post/Reel. STORY_REPLY & LIVE_COMMENT need Pro; AD_REFERRAL needs Pro+; POSTBACK (Ice Breaker / menu button) needs Pro and a postbackMatch. DM_KEYWORD = someone sends you a DM containing one of includeKeywords (at least one keyword, or an intentDescription, is required).

templateTextstring

The DM body. Supports {{handle}} and {{commentText}} tokens.

includeKeywordsstring[]

Only trigger when the comment contains one of these (case-insensitive). Empty = every comment. Max 50.

excludeKeywordsstring[]

Never trigger when the comment contains one of these (wins over includeKeywords). Max 50.

actionType'TEMPLATE' | 'AI_REPLY'

TEMPLATE sends templateText as-is. AI_REPLY generates a personalised reply — needs Pro+ (and Text format).

dmFormat'TEXT' | 'CAROUSEL' | 'MEDIA'

TEXT = plain message. CAROUSEL = image cards with buttons (Pro). MEDIA = image/video/PDF attachments (Pro).

carouselElementsobject[] nullable

Card definitions when dmFormat=CAROUSEL (2–10 cards: title, imageUrl, optional buttons).

mediaAssetIdsstring[]

Ordered media-asset IDs when dmFormat=MEDIA (1–10).

adIdsstring[]

Restrict AD_REFERRAL triggers to these numeric ad IDs.

postIdsstring[]

Restrict COMMENT triggers to these IG post IDs. Empty = all your posts.

refMatchstring nullable

Exact match on the ad/m.me ref parameter (for AD_REFERRAL).

postbackMatchstring nullable

Exact match on the postback payload. Required when triggerType=POSTBACK.

commentShieldHideNegativeboolean

Auto-hide negative comments on the triggering post. Needs Pro.

publicReplyTextstring nullable

Also post this as a public reply on the comment. Needs Pro.

intentDescriptionstring nullable

Plain-language description of the comments to catch (e.g. "people asking for the recipe or link"). Keywords match first; when none match, AI checks the comment against this intent in any language. With no includeKeywords, the automation is intent-only. Text-bearing triggers only. Needs Pro.

sentimentRouting'ALL' | 'POSITIVE_ONLY' | 'NEGATIVE_QUEUE'

Route by comment sentiment. Anything other than ALL needs Pro.

abTestEnabledboolean

Split traffic 50/50 between templateText and templateB. Needs Growth or higher.

templateBstring nullable

The B-variant body. Required when abTestEnabled=true.

followerOnlyFilterboolean

Only DM users who follow you.

askForFollowTextstring nullable

CTA sent to non-followers when followerOnlyFilter=true.

followToUnlockboolean

Gate the reward DM behind a follow. Needs Pro.

unlockButtonLabelstring nullable

Button label for the follow-to-unlock gate.

leadCaptureField'NONE' | 'EMAIL' | 'PHONE'

Ask for the person's email or phone number in the DM first, and send the reward once they reply with a valid one. Instagram only; not with followToUnlock. Needs Growth or higher.

leadCapturePromptstring nullable

Your own wording for the email/phone ask. Null uses the default.

languageTemplatesobject nullable

Per-language overrides keyed by ISO-639-1 code, e.g. {"es":"¡Hola!"}. Needs Pro.

dailyCapinteger

Max DMs this automation sends per day.

sendWindowStartstring nullable

Only send at/after this time each day, HH:MM 24h (account timezone).

sendWindowEndstring nullable

Only send at/before this time each day, HH:MM 24h.

skipPreviousRecipientsboolean

Don't re-DM someone this automation already messaged in the last 30 days.

clickTrackingboolean

Wrap the first link in the DM with a click-tracking redirect (default). Set false to send your original link unmodified — useful for affiliate links. Opting out needs a paid plan; free plans always track.

Response

Updated automation

idstring
namestring
activeboolean
triggerType'COMMENT' | 'STORY_REPLY' | 'AI_INTENT'
includeKeywordsstring[]
excludeKeywordsstring[]
templateTextstring
actionType'TEMPLATE' | 'AI_REPLY'
sentimentRouting'ALL' | 'POSITIVE_ONLY' | 'NEGATIVE_QUEUE'
abTestEnabledboolean
followerOnlyFilterboolean
dailyCapinteger
sendWindowStartstring nullable
sendWindowEndstring nullable
clickTrackingboolean

Wrap the first link in the DM with a click-tracking redirect (default). Set false to send your original link unmodified — useful for affiliate links. Opting out requires a paid plan (see "Send plain links" in the plan matrix); free plans always track.

createdAtstring date-time
updatedAtstring date-time
dripStepCountinteger

Changes

No recorded changes to this operation across all 1 revision of this API.