Path parameters

• Sid string Required

  A 34 character string that uniquely identifies this Sender.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^XE[0-9a-fA-F]{32}$.

Responses

• 202 application/json

  Accepted

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  • T-Request-Id string
  Hide response attributes Show response attributes object

  • sid string | null

    A 34 character string that uniquely identifies this Sender.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^XE[0-9a-fA-F]{32}$.

  • status string

    The Status of this Sender. One of CREATING, ONLINE, OFFLINE, PENDING_VERIFICATION, VERIFYING or ONLINE:UPDATING.

    Values are CREATING, ONLINE, OFFLINE, PENDING_VERIFICATION, VERIFYING, ONLINE:UPDATING, or STUBBED.

  • sender_id string | null

    The ID of this Sender prefixed with the channel, e.g., whatsapp:E.164

  • configuration object | null

    Configuration settings for creating a sender, e.g., {"waba_id": "1234567890", "verification_method": "sms"}

    Hide configuration attributes Show configuration attributes object | null

    • waba_id string | null

      The ID of the WhatsApp Business Account to use for this sender.

    • verification_method string | null

      The method to use for verification. Either "sms" or "voice".

      Values are sms or voice. Default value is sms.

    • verification_code string | null

      The verification code to use for this sender.

    • voice_application_sid string | null

      The SID of the Twilio Voice application to use for this sender.

  • webhook object | null

    Webhook specific configurations, e.g., {"callback_url": "https://xxx", "callback_method": "POST", "fallback_url": "https://xxx", "fallback_method": "POST", "status_callback_url": "https://xxx", "status_callback_method": "POST"}

    Hide webhook attributes Show webhook attributes object | null

    • callback_url string | null

      The URL to send the webhook to.

    • callback_method string | null

      The HTTP method to use for the webhook. Either "POST" or "PUT".

      Values are POST or PUT.

    • fallback_url string | null

      The URL to send the fallback webhook to.

    • fallback_method string | null

      The HTTP method to use for the fallback webhook. Either "POST" or "PUT".

      Values are POST or PUT.

    • status_callback_url string | null

      The URL to send the status callback to.

    • status_callback_method string | null

      The HTTP method to use for the status callback.

  • profile object | null

    Sender profile specific configurations for create and update request, e.g., {"name": "xxx", "about": "xxx", "address": "xxx", "description": "xxx", "emails": [{"label": "email 1", "email": "xxx@xxx"}], "logo_url": "https://xxx", "vertical": "xxx", "websites": [{"label": "email 1", "website": "https://xxx"}]}

    Hide profile attributes Show profile attributes object | null

    • name string | null

      The name of the sender.

    • about string | null

      The about text of the sender.

    • address string | null

      The address of the sender.

    • description string | null

      The description of the sender.

    • emails array[object] | null

      The emails of the sender.

      Hide emails attributes Show emails attributes object

      • email string
      • label string
    • logo_url string | null

      The logo URL of the sender.

    • vertical string | null

      The vertical of the sender. Allowed values are:

      • "Automotive"
      • "Beauty, Spa and Salon"
      • "Clothing and Apparel"
      • "Education"
      • "Entertainment"
      • "Event Planning and Service"
      • "Finance and Banking"
      • "Food and Grocery"
      • "Public Service"
      • "Hotel and Lodging"
      • "Medical and Health"
      • "Non-profit"
      • "Professional Services"
      • "Shopping and Retail"
      • "Travel and Transportation"
      • "Restaurant"
      • "Other"
    • websites array[object] | null

      The websites of the sender.

      Hide websites attributes Show websites attributes object

      • website string
      • label string
  • properties object | null

    Sender specific additional properties, e.g., {"quality_rating": "HIGH", "messaging_limit": "10K Customers/24hr"}

    Hide properties attributes Show properties attributes object | null

    • quality_rating string | null

      The quality rating of the sender.

    • messaging_limit string | null

      The messaging limit of the sender.

  • offline_reasons array[object | null] | null

    Reasons why the sender is offline., e.g., [{"code": "21211400", "message": "Whatsapp business account is banned by provider {provider_name} | Credit line is assigned to another BSP", "more_info": "https://www.twilio.com/docs/errors/21211400"}]

    Hide offline_reasons attributes Show offline_reasons attributes object | null

    • code string | null

      The error code.

    • message string | null

      The error message.

    • more_info string(uri) | null

      The URL to get more information about the error.

  • url string(uri) | null

    The URL of this resource, relative to https://messaging.twilio.com.