TWtwilio
MessagingV2ChannelsSender

Update a sender's information, including `profile`, `webhook`, and `configuration`.

Changed on

(WhatsApp only) Update a Sender. You can update a sender's information, including profile, webhook, and configuration. To verify a phone number, set configuration.verification_code to the One-time Password (OTP) that you received.

post/v2/Channels/Senders/{Sid}

Request

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

Path parameters

Sidstring required

The SID of the sender.

Request body

friendly_namestring nullable

Optional display label for the sender in the Twilio Console.

Example request

{
  "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.

display_name_status'updating' | 'no_change' | 'pending_review' | 'error' nullable

WhatsApp only. The outcome of the display name operation in this request. Present only when the request included profile.name. updating — accepted; either submitted to Meta for review, or, when Meta had already approved this exact name, routed straight to re-registration. no_change — the name already matches the sender's active display name; nothing was submitted to Meta. pending_review — the same name is already under review at Meta; the existing request continues unchanged. error — the display name could not be processed, while other profile fields in the same request were still applied. Returned with a 202 and carries no error code or message. This covers every failure mode, including the case where Meta accepted the name but tracking could not be started — poll pending_display_name_status to establish the real state rather than assuming the name was rejected. When profile.name is the only field in the request, the failure is returned as an error response with a specific code instead of this status.

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

  • v21b0133a1cf72Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status