TWtwilio
MessagingV2ChannelsSender

Create a Sender

Changed on

Create a Sender.

post/v2/Channels/Senders

Request

  • Base URL
    https://messaging.twilio.com
  • URL
    https://messaging.twilio.com/v2/Channels/Senders
  • Auth
    HTTP basic

Request body

sender_idstring nullable required

The ID of the sender in whatsapp:<E.164_PHONE_NUMBER> format.

friendly_namestring nullable

Optional display label for the sender in the Twilio Console.

Example request

{
  "sender_id": "whatsapp:+15017122661",
  "configuration": {
    "waba_id": "12345678912345",
    "verification_method": "sms"
  }
}

Response

Accepted

sidstring nullable

The SID of the sender.

status'CREATING' | 'ONLINE' | 'OFFLINE' | 'PENDING_VERIFICATION' | 'VERIFYING' | 'ONLINE:UPDATING' | 'TWILIO_REVIEW' | 'DRAFT' | 'STUBBED'

The status of the sender.

sender_idstring nullable

The ID of the sender in whatsapp:<E.164_PHONE_NUMBER> format.

friendly_namestring nullable

Optional display label for the sender in the Twilio Console.

pending_display_namestring nullable

WhatsApp only. The display name the most recent change applies to — awaiting Meta review, approved by Meta and awaiting re-registration, or, once pending_display_name_status is COMPLETED, the name now in effect (identical to name). Absent when no display name change has been made, and once a completed change stops being reported.

pending_display_name_status'PENDING_REVIEW' | 'APPROVED' | 'DECLINED' | 'PIN_MISMATCH' | 'REGISTRATION_FAILED' | 'EXPIRED' | 'COMPLETED' nullable

WhatsApp only. The status of the most recent display name change. PENDING_REVIEW, APPROVED and DECLINED are reported by Meta. PIN_MISMATCH and REGISTRATION_FAILED mean Meta approved the name but it could not be applied; EXPIRED means Meta's 14-day window to apply an approved name elapsed. In all three cases, re-submit the same profile.name to retry. COMPLETED means the name was approved and applied — name now returns it. A COMPLETED change is reported for 14 days after it completes and is absent afterwards, so treat its presence as "recently completed" rather than a permanent flag; use pending_display_name_status_date to tell how recent. Absent when no display name change has been made.

pending_display_name_status_datestring date-time nullable

WhatsApp only. The date and time in UTC when pending_display_name_status last changed, specified in ISO 8601 format. Absent whenever pending_display_name_status is absent, so the three pending_display_name* fields are always present or absent together.

urlstring uri nullable

The URL of the resource.

Example response

{
  "sender_id": "whatsapp:+15017122661",
  "configuration": {
    "waba_id": "12345678912345",
    "verification_method": "sms"
  },
  "properties": {
    "quality_rating": "HIGH",
    "messaging_limit": "10K Customers/24hr"
  },
  "compliance": {
    "countries": [
      {
        "country": "US"
      }
    ]
  }
}

Changes

  • v2c5c14a6098a3Revision changes
    • breaking

      the / request property's minLength was increased from 0 to 1

    • warning

      the / request property's maxLength was set to 255

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • v21b0133a1cf72Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status