Wati

App · 25 actions

Run your WhatsApp Business inbox in Wati: send messages, files, buttons and template messages (one at a time, in bulk or scheduled), manage contacts, assign, tag and resolve conversations, start chatbots and read campaigns, and start workflows when messages arrive or change status.

Actions

ActionWhat it does
Add contactAdd a contact with their WhatsApp number, name and attributes.
Add tag to conversationPut one of the workspace's tags on a conversation.
Assign conversationAssign a conversation to a team member, by the email they sign in to Wati with.
Delete contactDelete a contact from Wati.
Get campaignGet one campaign (broadcast) with how many messages were sent, delivered, read, replied to and failed.
Get contactGet one contact, by id or WhatsApp number, with their attributes, teams and opt-in.
Get message fileSave the picture, video, audio or document a message carries to your files, so a later step can attach or upload it.
Get templateGet one WhatsApp message template with its status, text, variables and buttons.
List campaignsList the workspace's campaigns (broadcasts) with their status and schedule.
List chatbotsList the workspace's chatbots.
List contactsList the workspace's contacts with their numbers, attributes and teams.
List conversationsList conversations in the team inbox, newest first, optionally for one channel.
List messagesList a conversation's messages and events, newest first.
List templatesList the workspace's WhatsApp message templates with their status, category, text and variables.
Remove tag from conversationTake a tag off a conversation.
Schedule template messageSchedule an approved WhatsApp template message to go to one or more numbers at a time you choose.
Send fileSend a picture, video, audio file or document in a conversation, with an optional caption.
Send messageSend a WhatsApp text message in a conversation.
Send message with buttonsSend a message with up to three reply buttons the contact can tap, such as Yes and No. Their answer arrives as a new message.
Send template messageSend an approved WhatsApp template message to one number, with values for its variables.
Send template message to manySend an approved WhatsApp template message to up to 10,000 numbers at once, each with values of its own if you like.
Set contact teamsPut a contact in the teams you name, replacing the teams they were in.
Start chatbotStart a chatbot in a contact's conversation.
Update contact attributesSet attributes (custom fields) on a contact, such as their city or plan.
Update conversation statusMark a conversation (its ticket) open, pending, solved or blocked.

Add contact

Add a contact with their WhatsApp number, name and attributes.

Inputs

WhatsApp numberwhatsapp_numbertextRequired
Their number with the country code, like 14155552671.
NamenametextRequired
Their name.
Attributesattributesobject
Each attribute's name with its value, such as city or plan. A name Wati doesn't have yet is added to its contact attributes.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "allow_broadcast": true,
    "allow_sms": false,
    "channel_id": "channel_123",
    "channel_type": "whatsapp",
    "contact_link": {
      "instagram_contact_id": "",
      "messenger_contact_id": "",
      "whats_app_contact_id": "507f191e810c19729de860ec"
    },
    "contact_status": "VALID",
    "created": "2026-01-15T10:30:00Z",
    "custom_params": [
      {
        "name": "city",
        "value": "London"
      }
    ],
    "display_name": "Jo B.",
    "id": "507f1f77bcf86cd799439012",
    "is_broadcast_limit_reached": false,
    "last_updated": "2026-02-10T14:45:00Z",
    "name": "Jo Bloggs",
    "opted_in": true,
    "phone": "+14155552671",
    "photo": "https://example.com/photos/jo.jpg",
    "segments": [],
    "source": "API",
    "teams": [
      "Support"
    ],
    "wa_id": "14155552671"
  }
}

Add tag to conversation

Put one of the workspace's tags on a conversation. The tag must already exist in Wati.

Inputs

ConversationconversationtextRequired
The conversation: its id from Wati or an earlier step, or the contact's WhatsApp number with the country code, like 14155552671.
TagtagtextRequired
The tag's name, as Wati shows it.

Outputs

successtrue/false
True once Wati accepted it
tagtext
The tag added
Example output
{
  "success": true,
  "tag": "VIP"
}

Assign conversation

Assign a conversation to a team member, by the email they sign in to Wati with.

Inputs

ConversationconversationtextRequired
The conversation: its id from Wati or an earlier step, or the contact's WhatsApp number with the country code, like 14155552671.
Team member's emailoperator_emailtextRequired
The email the team member signs in to Wati with.

Outputs

operator_emailtext
Who the conversation is assigned to
successtrue/false
True once Wati accepted it
Example output
{
  "operator_email": "jo@example.com",
  "success": true
}

Delete contact

Delete a contact from Wati. Wati hides it rather than erasing its history.

Inputs

ContactcontacttextRequired
The contact: their id from Wati or an earlier step, or their WhatsApp number with the country code, like 14155552671.

Outputs

contacttext
The contact deleted
deletedtrue/false
Always true once deleted
Example output
{
  "contact": "507f1f77bcf86cd799439012",
  "deleted": true
}

Get campaign

Get one campaign (broadcast) with how many messages were sent, delivered, read, replied to and failed.

Inputs

Campaign IDcampaign_idtextRequired
The campaign's id, from 'List campaigns' or a template send's broadcast_id.

Outputs

campaignobject
The campaign
Example output
{
  "campaign": {
    "channel_id": "channel_456",
    "created": "2026-01-15T10:30:00Z",
    "id": "broadcast_123456",
    "last_updated": "2026-01-20T12:00:00Z",
    "name": "Spring sale",
    "scheduled_at": "2026-02-01T09:00:00Z",
    "statistics": {
      "total_delivered": 950,
      "total_failed": 10,
      "total_pending": 0,
      "total_queued": 0,
      "total_read": 800,
      "total_recipients": 1000,
      "total_replied": 50,
      "total_sending": 0,
      "total_sent": 990,
      "total_stopped": 0
    },
    "status": "Completed",
    "template_id": "6929b0e8c1a2b3c4d5e6f7a8"
  }
}

Get contact

Get one contact, by id or WhatsApp number, with their attributes, teams and opt-in.

Inputs

ContactcontacttextRequired
The contact: their id from Wati or an earlier step, or their WhatsApp number with the country code, like 14155552671.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "allow_broadcast": true,
    "allow_sms": false,
    "channel_id": "channel_123",
    "channel_type": "whatsapp",
    "contact_link": {
      "instagram_contact_id": "",
      "messenger_contact_id": "",
      "whats_app_contact_id": "507f191e810c19729de860ec"
    },
    "contact_status": "VALID",
    "created": "2026-01-15T10:30:00Z",
    "custom_params": [
      {
        "name": "city",
        "value": "London"
      }
    ],
    "display_name": "Jo B.",
    "id": "507f1f77bcf86cd799439012",
    "is_broadcast_limit_reached": false,
    "last_updated": "2026-02-10T14:45:00Z",
    "name": "Jo Bloggs",
    "opted_in": true,
    "phone": "+14155552671",
    "photo": "https://example.com/photos/jo.jpg",
    "segments": [],
    "source": "API",
    "teams": [
      "Support"
    ],
    "wa_id": "14155552671"
  }
}

Get message file

Save the picture, video, audio or document a message carries to your files, so a later step can attach or upload it.

Inputs

Message IDmessage_idtextRequired
The message's id, from a 'Message received' trigger, 'List messages' or an earlier step.

Outputs

content_typetext
The file's type
document_reftext
The saved file, for steps that take a file
filenametext
The file's name
message_idtext
The message it came from
size_bytesnumber
The file's size
urltext
Where to open the file
Example output
{
  "content_type": "image/jpeg",
  "document_ref": "doc_0123456789abcdef",
  "filename": "photo.jpg",
  "message_id": "507f1f77bcf86cd799439011",
  "size_bytes": 48213,
  "url": "/actions/core/serve-document/doc_0123456789abcdef"
}

Get template

Get one WhatsApp message template with its status, text, variables and buttons.

Inputs

Template IDtemplate_idtextRequired
The template's Wati id, from 'List templates'.

Outputs

templateobject
The template
Example output
{
  "template": {
    "body": "Hello {{name}}, your order {{order_id}} is on its way!",
    "buttons": [],
    "buttons_type": "NONE",
    "category": "UTILITY",
    "creation_method": "HUMAN",
    "custom_params": [
      {
        "name": "name",
        "value": "Jo"
      },
      {
        "name": "order_id",
        "value": "1001"
      }
    ],
    "footer": "Reply STOP to unsubscribe",
    "header": {
      "link": "",
      "text": "Order update",
      "type": "Text"
    },
    "hsm": "Hello {{name}}, your order {{order_id}} is on its way!",
    "id": "6929b0e8c1a2b3c4d5e6f7a8",
    "language_option": {
      "key": "English (US)",
      "text": "English (US)",
      "value": "en_US"
    },
    "last_modified": "2026-01-15T10:30:00Z",
    "name": "order_update",
    "quality": "GREEN",
    "status": "APPROVED",
    "sub_category": "STANDARD",
    "type": "TEXT"
  }
}

List campaigns

List the workspace's campaigns (broadcasts) with their status and schedule. Gets one page; to see more, run it again with the next page number.

Inputs

Pagepage_numbernumber
Which page to get, starting at 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to get, 1 to 100. Defaults to 50.From 1 to 100.
Sending numberchanneltext
The WhatsApp number (or channel name) to send from. Leave empty for the workspace's default number.

Outputs

campaignslist
The campaigns
countnumber
How many on this page
page_numbernumber
This page's number, from 1
page_sizenumber
The most a page holds
totalnumber
How many there are in all
Example output
{
  "campaigns": [
    {
      "channel_id": "channel_456",
      "created": "2026-01-15T10:30:00Z",
      "id": "broadcast_123456",
      "last_updated": "2026-01-20T12:00:00Z",
      "name": "Spring sale",
      "scheduled_at": "2026-02-01T09:00:00Z",
      "status": "Completed",
      "template_id": "6929b0e8c1a2b3c4d5e6f7a8"
    }
  ],
  "count": 1,
  "page_number": 1,
  "page_size": 50,
  "total": 1
}

List chatbots

List the workspace's chatbots. Chatbots need a Wati Pro or Business plan.

Inputs

Pagepage_numbernumber
Which page to get, starting at 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to get, 1 to 100. Defaults to 50.From 1 to 100.

Outputs

chatbotslist
The chatbots
countnumber
How many on this page
page_numbernumber
This page's number, from 1
page_sizenumber
The most a page holds
Example output
{
  "chatbots": [
    {
      "created": "2026-07-14T16:15:38Z",
      "id": "607f1f77bcf86cd799439011",
      "name": "Order status bot"
    }
  ],
  "count": 1,
  "page_number": 1,
  "page_size": 50
}

List contacts

List the workspace's contacts with their numbers, attributes and teams. Gets one page; to see more, run it again with the next page number.

Inputs

Pagepage_numbernumber
Which page to get, starting at 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to get, 1 to 100. Defaults to 50.From 1 to 100.

Outputs

contactslist
The contacts
countnumber
How many on this page
page_numbernumber
This page's number, from 1
page_sizenumber
The most a page holds
Example output
{
  "contacts": [
    {
      "allow_broadcast": true,
      "allow_sms": false,
      "channel_id": "channel_123",
      "channel_type": "whatsapp",
      "contact_link": {
        "instagram_contact_id": "",
        "messenger_contact_id": "",
        "whats_app_contact_id": "507f191e810c19729de860ec"
      },
      "contact_status": "VALID",
      "created": "2026-01-15T10:30:00Z",
      "custom_params": [
        {
          "name": "city",
          "value": "London"
        }
      ],
      "display_name": "Jo B.",
      "id": "507f1f77bcf86cd799439012",
      "is_broadcast_limit_reached": false,
      "last_updated": "2026-02-10T14:45:00Z",
      "name": "Jo Bloggs",
      "opted_in": true,
      "phone": "+14155552671",
      "photo": "https://example.com/photos/jo.jpg",
      "segments": [],
      "source": "API",
      "teams": [
        "Support"
      ],
      "wa_id": "14155552671"
    }
  ],
  "count": 1,
  "page_number": 1,
  "page_size": 50
}

List conversations

List conversations in the team inbox, newest first, optionally for one channel. Gets one page; to see more, run it again with the next page number.

Inputs

Pagepage_numbernumber
Which page to get, starting at 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to get, 1 to 100. Defaults to 50.From 1 to 100.
Channel typechannel_typetext
Only conversations on this kind of channel.One of: whatsapp, whatsapp_group (WhatsApp groups), instagram, messenger, tiktok, webchat (Web chat), rcs.
Channel IDchannel_idtext
Only conversations on this connected channel.

Outputs

conversationslist
The conversations, newest first
countnumber
How many on this page
page_numbernumber
This page's number, from 1
page_sizenumber
The most a page holds
Example output
{
  "conversations": [
    {
      "channel_type": "whatsapp",
      "contact_id": "507f1f77bcf86cd799439012",
      "contact_name": "Jo Bloggs",
      "id": "685bd235e6119686e693a093",
      "last_updated": "2026-01-16T08:00:00Z",
      "started_date": "2026-01-15T10:30:00Z"
    }
  ],
  "count": 1,
  "page_number": 1,
  "page_size": 50
}

List messages

List a conversation's messages and events, newest first. Gets one page; to see more, run it again with the next page number.

Inputs

ConversationconversationtextRequired
The conversation: its id from Wati or an earlier step, or the contact's WhatsApp number with the country code, like 14155552671.
Pagepage_numbernumber
Which page to get, starting at 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to get, 1 to 100. Defaults to 50.From 1 to 100.

Outputs

channel_idtext
The channel the conversation is on
countnumber
How many on this page
messageslist
The messages and events, newest first
page_numbernumber
This page's number, from 1
page_sizenumber
The most a page holds
Example output
{
  "channel_id": "channel_123",
  "count": 1,
  "messages": [
    {
      "assigned_id": "6858f59a3374901cc1c8223f",
      "avatar_url": "https://example.com/avatar.png",
      "bot_type": "regular",
      "conversation_id": "685bd235e6119686e693a093",
      "created": "2026-07-14T16:15:38Z",
      "event_type": "message",
      "failed_detail": "",
      "id": "507f1f77bcf86cd799439011",
      "local_message_id": "88aed3c93a050b3c53978463",
      "operator_name": "Jo Bloggs",
      "owner": true,
      "status": "sent",
      "text": "Hello, your order is on its way!",
      "ticket_id": "68aed3c93a050b3c53978463",
      "timestamp": "2026-07-14T16:15:38Z",
      "type": "text"
    }
  ],
  "page_number": 1,
  "page_size": 50
}

List templates

List the workspace's WhatsApp message templates with their status, category, text and variables. Gets one page; to see more, run it again with the next page number.

Inputs

Pagepage_numbernumber
Which page to get, starting at 1. Defaults to the first.At least 1.
Page sizepage_sizenumber
How many to get, 1 to 100. Defaults to 50.From 1 to 100.
Sending numberchanneltext
The WhatsApp number (or channel name) to send from. Leave empty for the workspace's default number.

Outputs

countnumber
How many on this page
page_numbernumber
This page's number, from 1
page_sizenumber
The most a page holds
templateslist
The templates
totalnumber
How many there are in all
Example output
{
  "count": 1,
  "page_number": 1,
  "page_size": 50,
  "templates": [
    {
      "body": "Hello {{name}}, your order {{order_id}} is on its way!",
      "buttons": [],
      "buttons_type": "NONE",
      "category": "UTILITY",
      "creation_method": "HUMAN",
      "custom_params": [
        {
          "name": "name",
          "value": "Jo"
        },
        {
          "name": "order_id",
          "value": "1001"
        }
      ],
      "footer": "Reply STOP to unsubscribe",
      "header": {
        "link": "",
        "text": "Order update",
        "type": "Text"
      },
      "hsm": "Hello {{name}}, your order {{order_id}} is on its way!",
      "id": "6929b0e8c1a2b3c4d5e6f7a8",
      "language_option": {
        "key": "English (US)",
        "text": "English (US)",
        "value": "en_US"
      },
      "last_modified": "2026-01-15T10:30:00Z",
      "name": "order_update",
      "quality": "GREEN",
      "status": "APPROVED",
      "sub_category": "STANDARD",
      "type": "TEXT"
    }
  ],
  "total": 1
}

Remove tag from conversation

Take a tag off a conversation. Nothing changes if it isn't on it.

Inputs

ConversationconversationtextRequired
The conversation: its id from Wati or an earlier step, or the contact's WhatsApp number with the country code, like 14155552671.
TagtagtextRequired
The tag's name, as Wati shows it.

Outputs

successtrue/false
True once Wati accepted it
tagtext
The tag removed
Example output
{
  "success": true,
  "tag": "VIP"
}

Schedule template message

Schedule an approved WhatsApp template message to go to one or more numbers at a time you choose. Wati lists it as a scheduled campaign.

Inputs

Templatetemplate_nametextRequired
The approved WhatsApp template to send. Pick one, or type its name.
RecipientsrecipientslistRequired
Up to 10,000 WhatsApp numbers with the country code. To give someone values of their own, make them an object such as {"phone_number": "14155552671", "name": "Jo"}.
Send atscheduled_atdate and timeRequired
When to send it. A time already past sends at once.
Template valuestemplate_valuesobject
Values for the template's variables shared by every recipient. A recipient's own values win.
Campaign namebroadcast_nametext
The name the send is listed under in Wati's campaigns. Defaults to Lodol.
Sending numberchanneltext
The WhatsApp number (or channel name) to send from. Leave empty for the workspace's default number.

Outputs

broadcast_idtext
The campaign the send is listed under in Wati
failed_countnumber
How many recipients Wati gave errors for
recipientslist
Each recipient Wati took, with any errors it gave for them
scheduled_attext
When it will be sent (ISO 8601, UTC)
successtrue/false
True once Wati accepted it
Example output
{
  "broadcast_id": "broadcast_123456",
  "failed_count": 0,
  "recipients": [
    {
      "errors": [],
      "local_message_id": "local-msg-123",
      "phone_number": "14155552671",
      "target": "14155552671"
    }
  ],
  "scheduled_at": "2026-12-25T10:00:00Z",
  "success": true
}

Send file

Send a picture, video, audio file or document in a conversation, with an optional caption. Like any message, only within 24 hours of the contact's last message.

Inputs

ConversationconversationtextRequired
The conversation: its id from Wati or an earlier step, or the contact's WhatsApp number with the country code, like 14155552671.
FilefiletextRequired
The file to send: upload one, pick one an earlier step made, or paste a public link to one.
Captioncaptiontext
Text shown with the file.

Outputs

messageobject
The message sent
Example output
{
  "message": {
    "assigned_id": "6858f59a3374901cc1c8223f",
    "avatar_url": "https://example.com/avatar.png",
    "bot_type": "regular",
    "conversation_id": "685bd235e6119686e693a093",
    "created": "2026-07-14T16:15:38Z",
    "event_type": "message",
    "failed_detail": "",
    "id": "507f1f77bcf86cd799439011",
    "local_message_id": "88aed3c93a050b3c53978463",
    "operator_name": "Jo Bloggs",
    "owner": true,
    "status": "sent",
    "text": "Your receipt",
    "ticket_id": "68aed3c93a050b3c53978463",
    "timestamp": "2026-07-14T16:15:38Z",
    "type": "image"
  }
}

Send message

Send a WhatsApp text message in a conversation. WhatsApp only allows it within 24 hours of the contact's last message; otherwise send a template message.

Inputs

ConversationconversationtextRequired
The conversation: its id from Wati or an earlier step, or the contact's WhatsApp number with the country code, like 14155552671.
MessagetexttextRequired
The text to send.

Outputs

messageobject
The message sent
Example output
{
  "message": {
    "assigned_id": "6858f59a3374901cc1c8223f",
    "avatar_url": "https://example.com/avatar.png",
    "bot_type": "regular",
    "conversation_id": "685bd235e6119686e693a093",
    "created": "2026-07-14T16:15:38Z",
    "event_type": "message",
    "failed_detail": "",
    "id": "507f1f77bcf86cd799439011",
    "local_message_id": "88aed3c93a050b3c53978463",
    "operator_name": "Jo Bloggs",
    "owner": true,
    "status": "sent",
    "text": "Hello, your order is on its way!",
    "ticket_id": "68aed3c93a050b3c53978463",
    "timestamp": "2026-07-14T16:15:38Z",
    "type": "text"
  }
}

Send message with buttons

Send a message with up to three reply buttons the contact can tap, such as Yes and No. Their answer arrives as a new message.

Inputs

ConversationconversationtextRequired
The conversation: its id from Wati or an earlier step, or the contact's WhatsApp number with the country code, like 14155552671.
MessagebodytextRequired
The text above the buttons.
ButtonsbuttonslistRequired
One to three button labels, each up to 20 characters.
Headingheadertext
A short heading shown above the message.
Footerfootertext
Small text shown under the message.

Outputs

messageobject
The message sent
Example output
{
  "message": {
    "assigned_id": "6858f59a3374901cc1c8223f",
    "avatar_url": "https://example.com/avatar.png",
    "bot_type": "regular",
    "conversation_id": "685bd235e6119686e693a093",
    "created": "2026-07-14T16:15:38Z",
    "event_type": "message",
    "failed_detail": "",
    "id": "507f1f77bcf86cd799439011",
    "local_message_id": "88aed3c93a050b3c53978463",
    "operator_name": "Jo Bloggs",
    "owner": true,
    "status": "sent",
    "text": "Did your order arrive?",
    "ticket_id": "68aed3c93a050b3c53978463",
    "timestamp": "2026-07-14T16:15:38Z",
    "type": "interactive"
  }
}

Send template message

Send an approved WhatsApp template message to one number, with values for its variables. Templates can start a conversation at any time.

Inputs

Templatetemplate_nametextRequired
The approved WhatsApp template to send. Pick one, or type its name.
WhatsApp numberwhatsapp_numbertextRequired
Who to send it to, with the country code, like 14155552671.
Template valuestemplate_valuesobject
A value for each of the template's variables, such as name or order_id. The fields come from the template chosen.
Campaign namebroadcast_nametext
The name the send is listed under in Wati's campaigns. Defaults to Lodol.
Sending numberchanneltext
The WhatsApp number (or channel name) to send from. Leave empty for the workspace's default number.

Outputs

broadcast_idtext
The campaign the send is listed under in Wati
failed_countnumber
How many recipients Wati gave errors for
recipientslist
Each recipient Wati took, with any errors it gave for them
successtrue/false
True once Wati accepted it
Example output
{
  "broadcast_id": "broadcast_123456",
  "failed_count": 0,
  "recipients": [
    {
      "errors": [],
      "local_message_id": "local-msg-123",
      "phone_number": "14155552671",
      "target": "14155552671"
    }
  ],
  "success": true
}

Send template message to many

Send an approved WhatsApp template message to up to 10,000 numbers at once, each with values of its own if you like. Wati lists the send as a campaign.

Inputs

Templatetemplate_nametextRequired
The approved WhatsApp template to send. Pick one, or type its name.
RecipientsrecipientslistRequired
Up to 10,000 WhatsApp numbers with the country code. To give someone values of their own, make them an object such as {"phone_number": "14155552671", "name": "Jo"}.
Template valuestemplate_valuesobject
Values for the template's variables shared by every recipient. A recipient's own values win.
Campaign namebroadcast_nametext
The name the send is listed under in Wati's campaigns. Defaults to Lodol.
Sending numberchanneltext
The WhatsApp number (or channel name) to send from. Leave empty for the workspace's default number.

Outputs

broadcast_idtext
The campaign the send is listed under in Wati
failed_countnumber
How many recipients Wati gave errors for
recipientslist
Each recipient Wati took, with any errors it gave for them
successtrue/false
True once Wati accepted it
Example output
{
  "broadcast_id": "broadcast_123456",
  "failed_count": 0,
  "recipients": [
    {
      "errors": [],
      "local_message_id": "local-msg-123",
      "phone_number": "14155552671",
      "target": "14155552671"
    }
  ],
  "success": true
}

Set contact teams

Put a contact in the teams you name, replacing the teams they were in. Their conversations follow. Needs a Pro or Business plan.

Inputs

ContactcontacttextRequired
The contact: their id from Wati or an earlier step, or their WhatsApp number with the country code, like 14155552671.
TeamsteamslistRequired
The team names, as Wati shows them.

Outputs

successtrue/false
True once Wati accepted it
teamslist
The contact's teams now
Example output
{
  "success": true,
  "teams": [
    "Support"
  ]
}

Start chatbot

Start a chatbot in a contact's conversation. Needs a Wati Pro or Business plan.

Inputs

Chatbotchatbot_idtextRequired
The chatbot to start. Pick one, or give its id.
ContactcontacttextRequired
The contact: their id from Wati or an earlier step, or their WhatsApp number with the country code, like 14155552671.

Outputs

chatbot_idtext
The chatbot started
successtrue/false
True once Wati accepted it
Example output
{
  "chatbot_id": "607f1f77bcf86cd799439011",
  "success": true
}

Update contact attributes

Set attributes (custom fields) on a contact, such as their city or plan. Attributes not given keep their values.

Inputs

ContactcontacttextRequired
The contact: their id from Wati or an earlier step, or their WhatsApp number with the country code, like 14155552671.
AttributesattributesobjectRequired
Each attribute's name with its value, such as city or plan. A name Wati doesn't have yet is added to its contact attributes.

Outputs

contactobject
The contact as it is now
updatednumber
How many contacts changed
Example output
{
  "contact": {
    "allow_broadcast": true,
    "allow_sms": false,
    "channel_id": "channel_123",
    "channel_type": "whatsapp",
    "contact_link": {
      "instagram_contact_id": "",
      "messenger_contact_id": "",
      "whats_app_contact_id": "507f191e810c19729de860ec"
    },
    "contact_status": "VALID",
    "created": "2026-01-15T10:30:00Z",
    "custom_params": [
      {
        "name": "city",
        "value": "London"
      }
    ],
    "display_name": "Jo B.",
    "id": "507f1f77bcf86cd799439012",
    "is_broadcast_limit_reached": false,
    "last_updated": "2026-02-10T14:45:00Z",
    "name": "Jo Bloggs",
    "opted_in": true,
    "phone": "+14155552671",
    "photo": "https://example.com/photos/jo.jpg",
    "segments": [],
    "source": "API",
    "teams": [
      "Support"
    ],
    "wa_id": "14155552671"
  },
  "updated": 1
}

Update conversation status

Mark a conversation (its ticket) open, pending, solved or blocked. Needs a Pro or Business plan.

Inputs

ConversationconversationtextRequired
The conversation: its id from Wati or an earlier step, or the contact's WhatsApp number with the country code, like 14155552671.
StatusstatustextRequired
The conversation's new status.One of: open, pending, solved, block (Blocked).

Outputs

statustext
The status set
successtrue/false
True once Wati accepted it
Example output
{
  "status": "solved",
  "success": true
}

On this page