Remove Custom Fields and/or Tags from Customer

Remove tags and/or custom field values from a customer.

Before you call

  • For WhatsApp, phone is required, with country code.
  • For Instagram, set channelType to INSTAGRAM and send customerHandle (the customer's Instagram username, without the @). channelHandle (your Instagram account's username) takes the place of wabaNumber.
  • Send tags and/or customFields as lists of names.
  • wabaNumber (optional, with country code) must be a connected number. It, or channelHandle for Instagram, is required to remove channel-level custom fields.

How it works

  • Without wabaNumber or channelHandle, tags are removed from the customer's chats on every connected number or Instagram account.
  • Returns 404 if no Instagram customer matches customerHandle.
  • Results are per item: removed and errored lists for tags and customFields.
  • Errors you may see: "No such tag found", "Tag not assigned to chat", "No such custom field found", or insufficient permissions for a field.
  • shouldCreateChatLog (default true) controls whether custom field removal is logged in the chat.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Customer phone number with country code. Required for WhatsApp.

tags
array of strings
required

Array of tags to be removed

tags*
customFields
array of strings
required

Array of customFields to be removed

customFields*
string

Integration Waba Number with country code

string
enum

INSTAGRAM for an Instagram customer. Left out, the customer is on WhatsApp.

Allowed:
string

With channelType INSTAGRAM: the customer's Instagram username, without the @.

string

With channelType INSTAGRAM: your connected Instagram account's username, without the @.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json