Send a free-text WhatsApp message. Only works inside the 24-hour customer service window; outside it, use gambot_send_template.

Send an approved WhatsApp template with variables. Can initiate a conversation even outside the 24-hour window.

List conversations (contacts) ordered by most recent message.

Read the message history for a single conversation.

List all WhatsApp templates for the organization.

Get a single template by id, including Meta approval status.

Get the dynamic variables of a template.

Create a new WhatsApp template (submitted to Meta for approval). Name must be English, lowercase_with_underscores. Components use the full Meta shape and support: a TEXT or media (IMAGE/VIDEO/DOCUMENT) HEADER, a BODY with {{1}} variables, a FOOTER, and BUTTONS (QUICK_REPLY / URL / PHONE_NUMBER). For a media header you can either put example.header_handle on the HEADER component yourself (upload it first with gambot_upload_template_media), or simply pass headerMediaUrl (a public URL) and let Gambot upload it and inject the handle.

Upload a public media URL (image/video/document) to Meta and get a reusable header_handle for a template's media HEADER. Use the returned headerHandle inside a HEADER component: {type:'HEADER',format:'IMAGE',example:{header_handle:[headerHandle]}}.

Get contact field definitions (base + custom/dynamic). Contacts store custom values as top-level keys — pass them via 'customFields' on create/update.

Create a contact (returns the existing one if the phone is already known). Custom/dynamic fields go under 'customFields' (see gambot_get_contact_fields for keys).

Fetch a contact by phone number.

Update a contact — only the provided fields are changed. Custom fields go under 'customFields'.

Get lead field definitions: { baseFields, customFields }. Custom lead values are stored under a nested 'customFields' map — pass them the same way on create/update.

Create a CRM lead (contact created if missing, optional template send). Accepts all base lead fields plus a nested 'customFields' object. See gambot_get_lead_fields for available fields.

Update a lead — only the provided fields are changed. Accepts any base field plus a nested 'customFields' object (merged with existing custom values).

Get case (פנייה) field definitions: { baseFields, customFields }. Custom case values are stored under a nested 'customFields' map — pass them the same way on create/update.

Create a case (support ticket / פנייה). Accepts base fields plus a nested 'customFields' object.

Update a case — only the provided fields are changed. Accepts base fields plus a nested 'customFields' object (merged with existing custom values).

Create a task (optionally linked to a contact via contactPhone).

List leads (paginated).

Get a single lead by id.

List cases (paginated).

Get a single case by id.

List tasks for the organization.

Get a single task by id.

Update a task — only the provided fields are changed.

Create a price quote. quoteData holds the quote fields (title, items, total, contact…).

List price quotes (paginated).

Get a single quote by id.

Update quote fields (partial).

Create an invoice draft. invoiceData holds the invoice fields.

List invoices (paginated).

Get a single invoice by id.

Update invoice fields (blocked once issued/locked).

Issue an invoice — locks it and assigns the official document number.

Create a store order. Body holds order fields (customer, items, total…).

List orders (optionally filtered by status / store / date range).

Get a single order by id.

Update order fields (merge).

List e-signature documents (newest first).

Get a single e-signature document, including its signing results.

Get the signing link(s) to distribute for an existing signature document (one per signer). Share with signers via WhatsApp/email/SMS.

List web forms.

Get a single web form definition.

Get the stable public shareable link for a web form. Distribute it to customers via WhatsApp/email/SMS/QR; all submissions land in the form's submissions.

Get submissions (results) for a web form.

List document templates.

Get a single document template.

Get fill-only submissions generated from a document template.

Generate a distributable fill link for a document template. A template has no single static link (each customer fills their own copy), so this creates a fill-only instance and returns its public /form/ URL to share with the customer. Optionally pre-fill variables via contactPhone/leadId/variables.

Create an organization user (team member). Sends a welcome email + WhatsApp invite.

List organization users (excluding system bots).

Get a single user by id.

Update user fields — only the provided ones are changed.

Disable a user (status = inactive).

Enable a user (status = active).

Permanently delete an organization user (removes both the auth account and the profile). This is irreversible — prefer gambot_disable_user to just deactivate access.

List all broadcast campaigns for the organization.

List scheduled campaigns that are waiting to run.

Get a single campaign by id.

Get the run results/report for a campaign (sent/delivered/read/replies/clicks).

Create a WhatsApp broadcast campaign. Manual (run on demand) or scheduled (one-time / recurring). For a template broadcast set messageType='Template' + wabaTemplateId; for free text set messageType='regular' + message. Audience: recipientSource='Excel' + ExcelData, or ContactFilters (CRM segment), or legacy ContactsQuery. Scheduling: campaignTrigger='Scheduled' + scheduleType ('once' with runAt+timezone, or 'repeated' with interval/intervalNumber/endCondition).

Update a campaign (send the full campaign object).

Delete a campaign by id.

Run an existing (saved) campaign by id now (resolves recipients and executes).

Run an ad-hoc campaign WITHOUT saving it first. Provide an audience (recipientPhoneNumbers, excelRecipients or filters) and the message (messageType='Template'+templateId, or 'regular'+message). Compliance is built in: every org has an ACTIVE opt-out flow (recipients reply הסר/stop/unsubscribe to be excluded from future broadcasts); the response echoes it under optOut (enabled=true) and your consent-to-mail under consent.

Send a single-recipient TEST of a template or free-text message. Great for previewing before a full broadcast.

Broadcast a WhatsApp TEMPLATE to everyone in an Excel/CSV the user gave you — the easiest way to do a mail-merge blast. YOU (the agent) read the sheet and pass: rows (one object per row, keyed by the column header), phoneColumn (which column holds the phone), and the variable mapping — either variableColumns (ordered: 1st column → {{1}}, 2nd → {{2}}, …) or variableMapping ({ var1:'ColName', var2:'ColName2' }). TIP: call gambot_get_template_variables first to see how many variables the template expects, then map columns to them. Sends immediately by default; to SCHEDULE add scheduling fields (scheduleType:'once' + runAt + timezone, or scheduleType:'repeated' + interval/intervalNumber/endCondition) — scheduled sends are saved as a campaign. Every original column is also stored per-recipient (rowData) so later automations can use any value by name. Compliance is built in: the org's ACTIVE opt-out flow (reply הסר/stop/unsubscribe) auto-excludes recipients from future broadcasts; the response echoes it under optOut (enabled=true) and your consent under consent.

Check whether an organization already exists for a company + tax id (ח.פ/ת.ז), and whether an incomplete onboarding can be resumed. Use before creating a new trial.

Generate a unique organization name from a company name + tax id (adds a suffix if taken).

List phone numbers available to purchase for a country (via Twilio), so you can pick one to buy as the account's SIM/number. Pass the chosen phoneNumber to gambot_create_trial_account / gambot_create_paid_account as simInfo.selectedSimNumber with simInfo.purchaseInTwilio=true.

Create a new FREE-TRIAL organization + first user (no card required). Login credentials (temp password) are emailed & WhatsApp'd to the contact. WhatsApp/number options: useFreeNumber (Meta test number) · useCoexisting (existing WhatsApp Business number in simInfo.simNumberEntered) · BYO SIM (the customer's own number in simInfo.simNumberEntered) · Buy a SIM from us (simInfo.purchaseInTwilio=true + simInfo.selectedSimNumber from gambot_search_available_numbers). GLOBAL: send companyInfo.timezone (IANA) and companyInfo.country (ISO-3166 alpha-2) — they drive scheduling and locale. Neither hard-fails: a missing/invalid timezone is derived from country (else defaults to Asia/Jerusalem). For a paid account with a card on file (no trial) use gambot_create_paid_account instead. After creating, connect WhatsApp via the returned wabaConnectUrl or gambot_exchange_waba_token.

Create a new organization that goes STRAIGHT TO PAID — no free trial month. A payment method is MANDATORY: pass a card object; the card is verified with the clearing provider, its token is saved, and billing starts immediately (first charge on the next billing run). Use this when an AI agent has the customer's card and should provision a paying account in one call. Same number options and the same graceful companyInfo.timezone/country handling as gambot_create_trial_account (neither hard-fails). The raw card is sent only to the PCI-compliant clearing provider and never stored.

Verify a card with the clearing provider (Tranzila) and save its token to an organization, so an AI agent with the customer's card can put a payment method on file without the hosted page. The raw card is sent only to the PCI-compliant clearing provider and never stored. For a hosted alternative (customer types the card), use gambot_create_payment_link.

Build a secure hosted payment link (Tranzila) to add a card for an organization. Card data is never handled by the API — share the URL with the customer; the card token is saved on success.

Get the hosted page URL where the customer completes Meta Embedded Signup (the Facebook popup) to connect their WhatsApp Business account.

Complete Meta Embedded Signup by exchanging the authorization code returned by the Facebook popup. Registers the WABA, subscribes webhooks and registers the phone number.