Senders

Deactivate a sender channel

Changed on

Switch off the account connected to this sender for one channel. Sends on it are refused and it leaves the sender's channels. The account stays connected, so activating it again needs no reconnection.

The month already paid is not refunded, and re-activating before it ends charges nothing. Calling this on a channel that is already inactive changes nothing. Not available with test-mode keys.

post/v1/senders/{senderId}/channels/{channel}/deactivate

Request

  • Base URL
    https://api.zavu.dev
  • URL
    https://api.zavu.dev/v1/senders/{senderId}/channels/{channel}/deactivate
  • Auth
    HTTP bearer

Path parameters

senderIdstring required
channel'whatsapp' | 'telegram' | 'instagram' | 'messenger' | 'email' required

A channel whose connection has an on/off switch. sms, sms_oneway and voice are billed per message and per phone number, are always on, and have nothing to activate.

The channel to switch.

Response

The channel is inactive.

channel'whatsapp' | 'telegram' | 'instagram' | 'messenger' | 'email' required

A channel whose connection has an on/off switch. sms, sms_oneway and voice are billed per message and per phone number, are always on, and have nothing to activate.

deactivatedboolean required

True when this call switched the channel off. False when it was already inactive.

Example response

{
  "sender": {
    "id": "sender_12345",
    "name": "Primary sender",
    "phoneNumber": "+13125551212",
    "channels": [
      "sms",
      "voice"
    ],
    "webhook": {
      "url": "https://api.example.com/webhooks/zavu",
      "secret": "whsec_abc123...",
      "signatureVersion": "v2"
    },
    "whatsapp": {
      "displayPhoneNumber": "+14155551234",
      "paymentStatus": {
        "setupStatus": "COMPLETE",
        "methodStatus": "VALID"
      }
    },
    "emailAddress": "noreply@yourdomain.com"
  }
}

Changes

    • warning

      added the new contact.identity_linked enum value to the /// response property for the response status