Activities

Update an activity (partial); set status to activate or pause

patch/activities/{id}

Request

Path parameters

idstring uuid required

Request body

trigger'ig_comment' | 'ig_story' | 'ig_live' | 'ig_message' | 'fb_comment' | 'fb_live' | 'fb_message' | 'threads_reply'

ig_comment (instagram): A comment on an Instagram post or Reel. ig_story (instagram): A reply to (or mention in) an Instagram Story. post_ids, if set, are story ids. ig_live (instagram): A comment during an Instagram Live broadcast (only while the broadcast is live). ig_message (instagram): An Instagram DM sent to the account. dm_source "keywords" (default) answers DMs that match a keyword; dm_source "ads" answers only the first DM of a conversation opened from an ad (live video ads, click-to-Instagram-Direct ads), keywords optional. fb_comment (facebook): A comment on a Facebook Page post. The DM is sent through Messenger. fb_live (facebook): A comment during a Facebook Live broadcast (only while the broadcast is live). fb_message (facebook): A Messenger message sent to the Page; the activity replies in Messenger. dm_source "ads" answers only conversations opened from an ad (live video ads, click-to-Messenger ads). threads_reply (threads): A reply to a Threads post. Public reply only: Meta offers no Threads DM API. Meta allows up to 1,000 replies per Threads profile per 24 hours.

namestring

Internal name shown in the dashboard.

keywordsstring[]

Keywords that trigger the activity, e.g. ["+1", "want", "price"]. Case-insensitive. Empty array = every comment triggers it. ig_message needs at least one keyword unless dm_source is "ads".

dm_source'keywords' | 'ads'

ig_message and fb_message only. "keywords" (default): answer DMs that match a keyword. "ads": answer only the first DM of a conversation opened from an ad (Instagram/Facebook live video ads with a message button, click-to-Instagram-Direct or click-to-Messenger ads); keywords are optional and narrow it further.

match'contains' | 'exact'

"contains" (default): comment contains a keyword. "exact": comment equals a keyword.

public_repliesstring[]

Public replies posted under the comment; one is picked at random each time (avoids looking like spam). Not available for ig_story and fb_message.

post_scope'all' | 'selected' | 'next_post'

"all" (default): every post. "selected": only post_ids. "next_post": the next Instagram post you publish (ig_comment only).

post_idsstring[]

Post ids from list_recent_posts, or full post URLs (Instagram/Threads URLs are resolved to ids, which needs a live Meta call).

start_atstring nullable

Optional start time, ISO 8601 with timezone (e.g. 2026-10-10T20:00:00+08:00).

end_atstring nullable

Optional end time, ISO 8601 with timezone. Must be after start_at.

status'draft' | 'active' | 'paused'

Response

OK

idstring
namestring
status'draft' | 'active' | 'paused'
account_idstring
platform'instagram' | 'facebook' | 'threads'
trigger'ig_comment' | 'ig_story' | 'ig_live' | 'ig_message' | 'fb_comment' | 'fb_live' | 'fb_message' | 'threads_reply'

ig_comment (instagram): A comment on an Instagram post or Reel. ig_story (instagram): A reply to (or mention in) an Instagram Story. post_ids, if set, are story ids. ig_live (instagram): A comment during an Instagram Live broadcast (only while the broadcast is live). ig_message (instagram): An Instagram DM sent to the account. dm_source "keywords" (default) answers DMs that match a keyword; dm_source "ads" answers only the first DM of a conversation opened from an ad (live video ads, click-to-Instagram-Direct ads), keywords optional. fb_comment (facebook): A comment on a Facebook Page post. The DM is sent through Messenger. fb_live (facebook): A comment during a Facebook Live broadcast (only while the broadcast is live). fb_message (facebook): A Messenger message sent to the Page; the activity replies in Messenger. dm_source "ads" answers only conversations opened from an ad (live video ads, click-to-Messenger ads). threads_reply (threads): A reply to a Threads post. Public reply only: Meta offers no Threads DM API. Meta allows up to 1,000 replies per Threads profile per 24 hours.

keywordsstring[]
match'contains' | 'exact'
public_repliesstring[]
post_scope'all' | 'selected' | 'next_post'
post_idsstring[] nullable
start_atstring nullable
end_atstring nullable
created_atstring
updated_atstring
dashboard_urlstring

Changes

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