activate_flow
ChatGPTActivate a flow. Sets the flow live. Publishes the draft first when there is one, exactly like the builder's toggle. Plans cap live flows (403 plan_limit_reached). Send {} as the body.
add_competitor
ChatGPTTrack a competitor. Looks the handle up through Meta and starts tracking it. The account must be a public Instagram business or creator account; personal and private accounts cannot be read by anyone through the API (422 invalid_param). At the plan cap this is 403 plan_limit_reached, and an account you already track is 409 conflict. The first snapshot is taken immediately.
assign_conversation
ChatGPTAssign or unassign a conversation. Body {"assigned_to": <team member id>} to assign, {"assigned_to": null} to unassign. Moves pending or escalated to active and adds a system line to the transcript, exactly like the inbox.
block_user
ChatGPTBlock a user. Send exactly one of ig_username (blocks by Instagram handle, even before they have messaged) or conversation_id (blocks the person behind an existing conversation on any Meta channel).
book_appointment
ChatGPTBook an appointment. Books a slot the way the portal calendar does: the account's required customer fields are enforced (422 missing_fields), the time must be in the future (400 invalid_param) and free (409 slot_unavailable), the appointment is confirmed at once, synced to Google Calendar and GoHighLevel when connected, and appointment.booked fires. Business hours are not checked here: call availability first to offer open times. Attach conversation_id to link the booking to a person you are chatting with; no message is sent to them. date and time are the customer's wall-clock time in timezone (the account timezone when omitted).
cancel_appointment
ChatGPTCancel an appointment. Sets status cancelled, removes the Google Calendar and GoHighLevel events of a booking made in ChatGenius (an event imported from the owner's own calendar is left alone), fires appointment.cancelled. 409 already_cancelled if it already is. Send {} as the body.
create_custom_field
ChatGPTCreate a custom field. field_key is permanent after creation. Up to 15 active fields.
create_faq
ChatGPTCreate an FAQ. Counts against the plan cap. The answer is embedded for retrieval right away; embedding_pending is true if indexing is still catching up.
create_flow
ChatGPTCreate a flow. Creates a DRAFT from a definition (see GET /flows/nodes for the catalogue). The definition is validated first: structure, per-node config, the plan's node cap, channel compatibility with the trigger source, keyword collisions with active flows, and references to custom fields, comment triggers and other flows (422 invalid_definition with errors[] and warnings[]). Nothing runs until you publish and activate. The visual builder lays the nodes out the first time the flow is opened.
create_post
ChatGPTCreate a post. Creates a draft, or a scheduled post when scheduled_at is set (ISO-8601 with offset; a bare local time is read in the account timezone). Upload media afterwards with POST /posts/{id}/media, then publish or schedule. Rules: TikTok-only posts cannot be a carousel or story and carry no first comment or comment auto-reply; scheduling needs a caption (stories excepted) and a future time; the plan's monthly cap counts scheduled and published posts, a plain draft never holds a slot; a comment auto-reply on a scheduled post needs a free live comment-trigger slot (403 plan_limit_reached). tiktok.privacy_level must be one of the creator's options from GET /posts/capabilities.
create_service
ChatGPTCreate a service. Counts against the plan cap. is_virtual is honoured only when Google Calendar is connected and Meet links are on; otherwise it is stored as false. Images are added in the portal.
create_tag
ChatGPTCreate a tag. Idempotent on name: 201 when created, 200 when it already existed (colour unchanged).
delete_document
ChatGPTDelete a document. Removes the document and its embeddings.
delete_faq
ChatGPTDelete an FAQ. Removes the FAQ and its embeddings.
delete_flow
ChatGPTDelete a flow. Deletes the flow, its versions, sessions and media. A linked comment trigger is detached and paused. Permanent: the flow, its versions, sessions and analytics are gone. Confirm with the user, and prefer pause_flow.
delete_post
ChatGPTDelete a post. Removes the post and its media files. Published posts cannot be deleted (409 not_editable); the live post stays on the platform.
delete_service
ChatGPTDelete a service. Removes the service, its embeddings and its image file.
delete_tag
ChatGPTDelete a tag. Removes the definition and detaches it from every contact and conversation.
discard_flow_draft
ChatGPTDiscard a flow draft. Throws away the unpublished draft; the live version stands. Send {} as the body.
duplicate_flow
ChatGPTDuplicate a flow. Copies the flow as a new draft. Send {} as the body.
get_account
ChatGPTGet the account. Call this first. Identity, plan, the calling key and its scope, and the configured webhook endpoints. When no Instagram, Facebook or WhatsApp account is connected, setup.channels_connected is false and setup.connect_url is where the owner connects one; until then the inbox, contact, comment and post tools return nothing.
get_account_insights
ChatGPTGet account insights. Reach, profile views, interactions, saves, shares and follows for your own account over the last 1, 7 or 30 days. This one calls Instagram live, so it takes a moment and counts against Meta's rate limit. 403 permission_required when the account was connected without the insights permission; reconnect it in the portal to fix that.
get_ai_channels
ChatGPTGet the per-channel AI switches. For meta (Facebook + Instagram share one switch), sms, whatsapp and telegram: whether the channel is connected, whether the AI answers on it, and whether automations run on it.
get_ai_config
ChatGPTGet the AI configuration. All nine sections in one call. available on file_handling, followups, csat and comment_ai says whether the plan includes that feature.
get_appointment
ChatGPTGet an appointment. One appointment by id.
get_audience_demographics
ChatGPTGet audience demographics. The latest stored breakdown of your followers: gender and age as percentages, top countries and cities with counts, and followers online by hour when Instagram supplies it. 404 until the first refresh. Instagram withholds all of it for accounts under roughly 100 followers, which comes back as zeros rather than an error. Includes followers online by hour, which is what "when should I post" is answered from.
get_availability
ChatGPTGet availability. The open slots for one day, from business hours, the service duration, the buffer, the minimum notice and existing bookings. What the bot and the portal picker offer. Empty on a closed day.
get_competitor
ChatGPTCompare against one competitor. That competitor and your own account side by side, with the per-metric differences the portal shows. Stored snapshots, no Meta call.
get_competitor_leaderboard
ChatGPTGet the leaderboard. Your account and every competitor ranked together: followers, engagement rate, posts per week, average likes and comments, follower growth per day and the content mix (reels, photos, carousels). This is the table behind the portal's Market Intel page. Stored snapshots, so it is instant and spends no Meta quota. Your account and every competitor ranked together. Start here for any "how do I compare" question.
get_contact
ChatGPTGet a contact. One contact by id.
get_conversation
ChatGPTGet a conversation. One conversation by id.
get_document
ChatGPTGet a document. One document by id, metadata only.
get_faq
ChatGPTGet an FAQ. One FAQ by id.
get_flow
ChatGPTGet a flow. One flow by id.
get_flow_analytics
ChatGPTGet flow analytics. The builder's Analytics panel for one flow: runs, completions, completion rate and median time for the window, the same numbers for the preceding window (comparison), lifetime totals, outcomes (emails and phones collected, leads marked, bookings, link clicks, handoffs), per-node reach, continue, response and loss rates, and per-port branch splits. Analytics are per published version: version defaults to the current one; versions lists the others. Only sessions with tracking are counted; other_version_runs_excluded says how many ran under another version in the window.
get_flow_definition
ChatGPTGet a flow definition. The definition alone: the draft when one exists, else the published version.
get_flow_node_catalogue
ChatGPTGet the node catalogue. Everything needed to build a flow: every trigger source (channels it can fire on, whether it needs keywords, its config), every node type (input and output ports, config fields and allowed values, which are terminal), the enums, the placeholders, the structural rules, and this account's live options: custom fields, tags, bookable services, flows (for goto_flow), comment triggers (for linked comment flows), the plan's node and flow caps. Read it before composing a definition. Read this before writing a flow definition. It lists every node type, its config fields and output ports.
get_flow_session
ChatGPTGet a flow session. One session by id.
get_follower_history
ChatGPTGet follower history. Follower count and engagement rate over the window, one series per account including your own, oldest point first. One point per day that a snapshot was taken, so gaps mean nobody refreshed that day.
get_handled_comment
ChatGPTGet a handled comment. One log row by id.
get_knowledge_usage
ChatGPTGet knowledge base usage. How many items exist against the plan cap, broken down by FAQs, services and documents, plus document storage. Check can_add before creating.
get_overview
ChatGPTGet the account overview. The numbers behind the portal's Overview page, computed by the same data layer: a rolling window against the same length of time before it (current/previous pairs). Messages per channel, AI vs automation replies, flow entries (with an attached comment trigger's fires on the flow's own row so a comment is never counted twice), standalone comment trigger fires, contacts, appointments with the next few, knowledge gaps by status, what needs a human, API sends, and plan usage for the billing cycle. Usage is always the billing cycle, whatever the range.
get_post
ChatGPTGet a post. One post with its media, published ids and any error.
get_posting_capabilities
ChatGPTGet posting capabilities. What to read before building a post: which targets are connected, the TikTok creator's allowed privacy levels and video limit (live from TikTok, with a safe fallback), the post types, and the plan's monthly post cap and storage cap with current usage.
get_service
ChatGPTGet a service. One service by id.
get_wins_and_opportunities
ChatGPTGet wins and opportunities. The comparisons already computed against each competitor over the last 30 days: where you are ahead (wins) and where they are (opportunities), each with the metric and the size of the gap. Derived from stored snapshots, no AI involved.
list_appointments
ChatGPTList appointments. In-chat bookings, newest first.
list_blocked_users
ChatGPTList blocked users. Everyone the AI is currently refusing to answer. Not paginated.
list_competitors
ChatGPTList tracked competitors. Every account you track, with the numbers from its latest stored snapshot, plus how many slots your plan allows. Free 1, Creator 3, Pro 5, Business 10. Whole set in one page. last_snapshot_date is null until the first refresh.
list_contacts
ChatGPTList contacts. Cursor-paginated, newest first. Filters combine with AND.
list_conversations
ChatGPTList conversations. Cursor-paginated, newest first. Deleted conversations are never returned.
list_custom_fields
ChatGPTList custom field definitions. Active fields by default.
list_documents
ChatGPTList documents. Uploaded PDFs and text files. Content is not returned, only metadata and embedding state. Upload happens in the portal.
list_faqs
ChatGPTList FAQs. Question and answer pairs the AI answers from. Active only by default.
list_flow_events
ChatGPTList flow events across sessions. Every session event in one feed, oldest first. Ids only increase, so starting_after is a durable high-water mark for a sync loop. Use flow_session, not session_id, to filter by session.
list_flow_session_events
ChatGPTList events for a session. The ordered path one person took through a flow, oldest first.
list_flow_sessions
ChatGPTList flow sessions. One session per person per run of a flow. Attribution carries post_id, comment_id and matched_keyword only, never what anyone typed.
list_flows
ChatGPTList flows. Automation flows with lifetime stats. The canvas definition is not exposed.
list_handled_comments
ChatGPTList handled comments. Comments the AI Comment Manager handled, newest first, kept 30 days. Each carries the comment, its sentiment, what moderation did, the AI draft, and what happened to the reply. status=pending is the approval queue.
list_knowledge_gaps
ChatGPTList knowledge gaps. Questions the AI could not answer well, flagged by the gap detector with the customer message, the AI reply, a canonical form of the question, and a suggested answer and target. Open gaps by default; status=all for everything. Read-only: fix a gap with POST /knowledge/faqs or by editing identity.instructions, and dismiss it in the portal.
list_messages
ChatGPTList messages in a conversation. The transcript, newest first. Purged bodies appear with text null and body_purged true.
list_opt_outs
ChatGPTList opt-outs. Who has opted out, on which channel, when, and how. starting_after is an opaque cursor here, not an id.
list_post_performance
ChatGPTList post performance. Your own recent posts with their stored performance: reach, impressions, likes, comments, saves, shares, video views, engagement rate and save rate. Newest first. Stored, so refresh first for current numbers.
list_posts
ChatGPTList posts. Content Studio posts, newest first, each with its media. status=scheduled is the queue, status=failed needs attention.
list_recent_posts
ChatGPTList recent posts. Recent posts and Reels on the connected Instagram or Facebook account, newest first, straight from Meta. Use an id as post_id when creating a trigger scoped to one post. 409 not_connected when that channel is not connected.
list_services
ChatGPTList services. Services and pricing the AI can quote and, with booking on, offer. Active only by default.
list_tags
ChatGPTList tags. Every tag definition, ordered by name. Not paginated.
list_team_members
ChatGPTList team members. Everyone a conversation can be assigned to. Not paginated. channels is null when the member can see every channel. Use it to find the member id for assign_conversation.
pause_flow
ChatGPTPause a flow. Stops the flow and cancels its open sessions. A linked comment trigger is paused with it. Fires flow.paused. Send {} as the body.
publish_flow
ChatGPTPublish a flow draft. Makes the draft the live definition (new version). Runs the full validation and keyword-conflict check (422 invalid_definition). Publishing a flow that was never live also activates it when the plan has a free live-flow slot (403 plan_limit_reached otherwise). Fires flow.published, and flow.activated when it went live. Send {} as the body.
publish_post
ChatGPTPublish a post now. Publishes to every target at once, the portal's Publish Now. Needs a caption (stories excepted), media for any Instagram target, and two or more items for a carousel (400). A draft, scheduled or failed post can be published (409 not_editable otherwise). When a platform rejects it the post becomes failed and the call is 422 publish_failed with the post and per-platform results. post.published or post.failed fires either way. Send {} as the body.
refresh_market_intel
ChatGPTRefresh from Meta. Pulls current numbers from Meta for your account and every tracked competitor and writes today's snapshot, exactly like the portal's Refresh button. One Meta call per account, so it takes several seconds; every other Market Intel read serves the snapshots this writes. Five minutes are enforced between refreshes (429 too_soon carries retry_after_seconds). Send {} as the body. Slow: one Meta call per tracked account. Only call it when the stored snapshot is stale.
remove_competitor
ChatGPTStop tracking a competitor. Frees the slot. History is kept, so re-adding the same handle picks up where it left off.
reschedule_appointment
ChatGPTReschedule an appointment. Moves a pending or confirmed appointment to a new date and time after checking the slot is free (its own current slot does not count as taken), updates the connected calendars, and fires appointment.rescheduled. The customer is not messaged. A booking with no conversation must also fall inside business hours. 400 invalid_param for a time in the past, 404 not_found for an unknown id, 409 slot_unavailable when the slot is taken or outside business hours, 409 not_active when the appointment is not pending or confirmed.
retry_post
ChatGPTRetry a failed post. Publishes a failed post again, up to the retry cap. Send {} as the body.
schedule_post
ChatGPTSchedule a post. Sets or moves the publish time of a draft, failed or scheduled post. The scheduler publishes it within a minute of that time. Same rules as scheduling on create. post.scheduled fires.
send_message
ChatGPTSend a message. Send text, a WhatsApp template, a reaction, or a typing indicator on any channel. Route by conversation_id, by platform plus platform_user_id, or by to_phone for SMS and WhatsApp. SMS, WhatsApp and Telegram can start a conversation cold; Facebook and Instagram need an inbound message first. idempotency_key is required in the body, or send the Idempotency-Key header. This reaches a real person on their phone. Confirm the recipient and the text with the user before calling.
tag_contact
ChatGPTAttach a tag. Attach by name. The tag is created if it does not exist. Re-attaching is a no-op.
unblock_user
ChatGPTUnblock a user. The AI answers their next message. The block row is kept for audit, so the id is not reusable.
unschedule_post
ChatGPTUnschedule a post. Turns a scheduled post back into a draft. Send {} as the body.
untag_contact
ChatGPTDetach a tag. Detach by tag id or URL-encoded name. Detaching a tag the contact does not have is a 200.
update_appointment
ChatGPTUpdate an appointment. Edit details and/or status, the portal's edit form. Send only what changes. Detail edits are pushed to the connected calendars; a status change to cancelled removes the calendar event and fires appointment.cancelled. Events imported from the owner's own Google Calendar are changed in ChatGenius only. To move the time use reschedule, which checks the slot. Edits are pushed to the connected calendar, and a status of cancelled removes the event. To move the time, use reschedule_appointment.
update_contact
ChatGPTUpdate a contact. Partial update. Only the fields you send change. An empty string clears name, email, phone or notes. custom_fields merges per key; null clears one value.
update_conversation
ChatGPTUpdate a conversation. Two optional fields. status: active, resolved or archived; resolving or archiving hands the thread back to the AI, like the inbox. ai_paused: true takes the thread away from the AI as the account owner (the inbox Claim button, reopens a resolved thread); false hands it back (the inbox Transfer to AI). Resume is refused with 409 when the pause came from a solicitation pause, a fraud flag or a connected-account pause; those are lifted in the portal. status is applied first, then ai_paused.
update_custom_field
ChatGPTRename or archive a custom field. Change the label, or archive and unarchive. Archived fields keep their values but stop appearing on contacts.
update_document
ChatGPTRename or toggle a document. Change the name or switch it off without deleting it.
update_faq
ChatGPTUpdate an FAQ. Partial update. Changing question, answer or keywords re-embeds it; changing only active does not.
update_flow
ChatGPTUpdate a flow. Rename, retarget channels, set the tag, and/or replace the definition. A new definition is saved as the DRAFT and validated the same way as on create; the live version keeps running until you publish. Positions are dropped when the definition changes (the builder re-lays it out).
update_post
ChatGPTUpdate a post. Edit a draft, scheduled or failed post (409 not_editable otherwise). Send only what changes; tiktok merges field by field; other arrays and objects replace. scheduled_at set moves or schedules it (post.scheduled fires); scheduled_at null turns a scheduled post back into a draft.
update_service
ChatGPTUpdate a service. Partial update. Any content change re-embeds; changing only active does not. The service image is never touched by the API.
upsert_contact
ChatGPTCreate or update a contact. Upsert keyed by (channel, platform_user_id). 201 when created, 200 when an existing contact was updated. Fields you omit on an existing contact are left untouched, tags included.
validate_flow
ChatGPTValidate a flow definition. Dry run of the same validation create and update apply. Nothing is saved. Validate a definition without saving it. Loop on errors[] until it is clean, then call create_flow.
activate_flow
Claudeadd_competitor
Claudeassign_conversation
Claudeblock_user
Claudebook_appointment
Claudecancel_appointment
Claudecreate_custom_field
Claudecreate_faq
Claudecreate_flow
Claudecreate_post
Claudecreate_service
Claudecreate_tag
Claudedelete_document
Claudedelete_faq
Claudedelete_flow
Claudedelete_post
Claudedelete_service
Claudedelete_tag
Claudediscard_flow_draft
Claudeduplicate_flow
Claudeget_account
Claudeget_account_insights
Claudeget_ai_channels
Claudeget_ai_config
Claudeget_appointment
Claudeget_audience_demographics
Claudeget_availability
Claudeget_competitor
Claudeget_competitor_leaderboard
Claudeget_contact
Claudeget_conversation
Claudeget_document
Claudeget_faq
Claudeget_flow
Claudeget_flow_analytics
Claudeget_flow_definition
Claudeget_flow_node_catalogue
Claudeget_flow_session
Claudeget_follower_history
Claudeget_handled_comment
Claudeget_knowledge_usage
Claudeget_overview
Claudeget_post
Claudeget_posting_capabilities
Claudeget_service
Claudeget_top_posts
Claudeget_wins_and_opportunities
Claudelist_appointments
Claudelist_blocked_users
Claudelist_competitors
Claudelist_contacts
Claudelist_conversations
Claudelist_custom_fields
Claudelist_documents
Claudelist_faqs
Claudelist_flow_events
Claudelist_flow_session_events
Claudelist_flow_sessions
Claudelist_flows
Claudelist_handled_comments
Claudelist_knowledge_gaps
Claudelist_messages
Claudelist_opt_outs
Claudelist_posts
Claudelist_recent_posts
Claudelist_services
Claudelist_tags
Claudelist_team_members
Claudepause_flow
Claudepublish_flow
Claudepublish_post
Clauderefresh_market_intel
Clauderemove_competitor
Claudereschedule_appointment
Clauderetry_post
Claudeschedule_post
Claudesend_message
Claudetag_contact
Claudeunblock_user
Claudeunschedule_post
Claudeuntag_contact
Claudeupdate_appointment
Claudeupdate_contact
Claudeupdate_conversation
Claudeupdate_custom_field
Claudeupdate_document
Claudeupdate_faq
Claudeupdate_flow
Claudeupdate_post
Claudeupdate_service
Claudeupsert_contact
Claudevalidate_flow
Claude