Botcake

Showing 25 of 49 from the live probe.

• Verify access to a page

  Connectivity/permission check for a page: the server resolves the page's access token from your x-api-key and echoes back the page id. Use it to confirm your credentials can act on a given page_id. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• List a page's flows (flat, 10 per page)

  Returns non-removed, named flows for the page, newest-updated first, 10 per page (flat list of {id, name}). Use to discover flow ids/names before sending a flow. Simpler alternative to list_flows (which returns the full folder tree). Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• Send a flow to one customer (simple)

  Sends the flow identified by flow_id to the customer psid. flow_id must be an integer and psid a valid recipient id. Simpler variant of send_flow (no returning/from options). Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• List a page's subscribed customers (10 per page)

  Returns subscribed customers (is_subscribed) for the page, newest-updated first, 10 per page. Same result as list_page_customers. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• List/generate per-page public API tokens

  Returns each page you manage with a public API access token (minting one for MANAGE/CREATE_CONTENT roles if absent). The server calls this internally to resolve page tokens; you rarely need it directly. Identified by your x-api-key. Auth: send your user token as `x-api-key`.

• List page ids you manage

  Returns the page ids linked to your account (excluding removed links), newest first. Identified by your x-api-key. Auth: send your user token as `x-api-key`.

• List a page's subscribed customers (10 per page)

  Returns subscribed customers for the page (id, psid, full_name, phone_number), newest-updated first, 10 per page. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• Get a customer's interaction history (50 per page)

  Returns the message/interaction history rows for the customer psid on the page, newest first, 50 per page. success:false if the customer/page is not found. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• Update a customer's custom field values

  Updates one or more custom field values for the customer psid. `data` is a list of objects like {id: <custom_field_id>, value: <value>}. Discover field ids via list_custom_fields. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• Get a customer's custom field values

  Returns the stored custom field values for the customer psid plus the customer's full name. success:false if the customer is not found. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• List customers holding a value for a custom field (50 per page)

  Returns customers that have a stored value for the given custom_field_id, with the value and field name, 50 per page. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• List a page's full flow/folder tree

  Returns the full flow tree for the page: {data: {folders: [...], flows: [...]}}. Use to discover flow_id values before sending a flow. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• List flows/folders under a specific tree path

  Same as list_flows but restricted to items whose tree path equals `path`. `path` is a JSON-encoded array of numbers, e.g. "[1,2]". Use to drill into a folder subtree. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• Send an existing flow to one recipient

  Sends the blocks of an existing flow (by flow_id) to a single recipient psid. Optionally injects template variables via payload. flow_id must be an integer; psid must be a valid recipient for the page platform. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• Send ad-hoc content to one or many recipients

  Sends an ad-hoc content block (`data`, a map of message blocks) to a single recipient (psid) or, for WhatsApp Business pages, a batch (psids, max 100). psids takes priority over psid. Supports an optional message_tag for out-of-24h-window sends. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• Get send/delivery statistics for a flow

  Returns aggregate delivery stats for one flow: {sent, delivery, seen, is_clicked, total_phone_number}. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• List a page's message sequences

  Returns all message sequences on the page ({id, name}), newest first. Use to discover sequence_id values before requesting sequence statistics. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• Get per-message statistics for a sequence

  Returns delivery statistics for each message/broadcast in the sequence (one row per message: sends, delivery, seen, is_clicked, message_id, name, schedule). Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• Get per-recipient statistics for a sequence message (200 per page)

  Returns per-recipient delivery details (psid, name, phone, delivery/seen/clicked flags) for a specific message within a sequence, 200 per page. Use the `page` query param to page through recipients. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• List a page's keyword→flow automations

  Returns every keyword record for the page ({id, is_activated, flow_id}). No pagination. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• Create a new (empty) keyword record

  Creates a blank keyword record for the page (the request body is ignored). Returns the new keyword id; bind it to a flow afterwards with update_keyword. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• Update a keyword's flow binding

  Updates an existing keyword (by keyword_id). Only `flow_id` inside the `update` object is applied; other keys are ignored. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• List a page's tags (50 per page)

  Returns the page's tags ({id, name, pancake_tag_id}), newest first, 50 per page. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• Get per-tag attach/detach stats over a time range (50 per page)

  Aggregates tag attach/detach counts for the page over [start_date, end_date], grouped by tag, 50 per page. Provide start_date/end_date as Unix timestamps for meaningful results. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).

• List a page's custom field definitions (50 per page)

  Returns the custom field definitions for the page ({id, name, type, description}), newest first, 50 per page. Use to discover custom_field ids/types before reading or updating customer field values. Auth: send your user token as `x-api-key`; the server resolves this page's access token automatically. Provide `page_id` (argument or `X-Botcake-Page-Id` header).