Chatbot Operations

Turn a messaging integration on or off

Toggle or set the activation status of a WhatsApp, Messenger, Instagram or LINE integration for a specific chatbot. Telegram and WhatsappWebAPI cannot be toggled: the call returns active: null and changes nothing.

post/toggle-bot-activation

Request

  • Base URL: https://api.chat-data.com/api/v2
  • URL: https://api.chat-data.com/api/v2/toggle-bot-activation
  • Auth: HTTP bearer

Request body

chatbotIdstring required

The unique identifier of the chatbot.

type'Whatsapp' | 'WhatsappWebAPI' | 'Telegram' | 'Messenger' | 'Instagram' | 'Line' required

The type of third-party messaging platform.

idstring required

The ID of the integration to toggle — the phone number ID for WhatsApp, the page ID for Messenger/Instagram, or the integration's own ID for LINE. For WhatsApp, Messenger and Instagram, you can find it in the ID column of the integration modal.

activeboolean

If provided, sets the activation status to this value. If omitted, the current status is toggled.

Example request

{
  "id": "109876543210987"
}

Response

Successful response.

status'success' required
activeboolean nullable required

The updated activation status. null when the chatbot's integration of this type has no phone number or page with this id; nothing is changed then.

Changes

No recorded changes to this operation across all 1 revision of this API.