Skip to content

Connect WhatsApp

Remove Cloud API numbers

With ?id=, removes that Cloud API number. Without it, removes all Cloud API credentials of the workspace. Returns the remaining channel configuration.

DELETE/api/v1/channel
  • Console only: owner or admin
  • Workspace: X-Tenant-ID

Headers

  • Cookiestringrequired

    The whatsappx_session cookie the app sets when you sign in. Browsers send it automatically; API keys are not accepted on this endpoint.

    Example
    whatsappx_session=…
  • X-Tenant-IDuuidrequired

    Workspace id. Required for session requests. You can pass ?tenant=<id> instead.

    Example
    8d0f6c2e-3b1a-4c55-9a7e-2f4b6d1e9c30

Query parameters

  • iduuidoptional

    Channel to remove. Leave it out to remove every Cloud API number.

Response

200 OKapplication/json

  • configuredboolean

    true when at least one Meta (Cloud API) number is connected.

  • activeenum

    meta when a Cloud API number is connected, otherwise scan.

  • iduuidmay be absent

    Id of the primary Meta channel.

  • providerstringmay be absent

    meta for the primary channel.

  • phone_idstringmay be absent

    Meta phone number id of the primary channel.

  • waba_idstringmay be absent

    WhatsApp Business Account id of the primary channel.

  • phonestringmay be absent

    Phone number of the primary channel.

  • versionstringmay be absent

    Graph API version of the primary channel.

  • webhook_pathstringmay be absent

    Callback path Meta should call, for example /api/webhooks/meta.

  • webhook_urlstringmay be absent

    Full callback URL, when the public URL is configured.

  • webhook_managedboolean

    true when whatsappx.si manages the Meta app and webhook subscription for you.

  • live_sendboolean

    Messages are sent for real (always true).

  • channelsarray<object>may be absent

    All connected Meta numbers.

    Show child attributesHide child attributes5
    • iduuid

      Channel id.

    • phone_idstring

      Meta phone number id.

    • waba_idstring

      WhatsApp Business Account id.

    • phonestring

      Display phone number saved for the channel.

    • versionstring

      Graph API version, for example v23.0.

Status codes

  • 200OK. The channel configuration after the removal.
  • 400Bad request. id is not a valid UUID.
  • 401Unauthorized. No signed-in session (unauthorized).
  • 403Forbidden. API keys can never call this endpoint (API keys cannot administer workspaces). A signed-in user who is not an owner or admin gets admin required; a user who is not a member of the workspace gets forbidden.
  • 404Not found. No channel with this id.
  • 500Server error. Something went wrong on our side. Retry with backoff.