SIsinch
WhatsApp Senders

Updates a sender in project

Changed on 
Updates a sender in project. Pending sender updates are tracked in "changes", except "displayName", which is tracked
in "metadata.displayName".
patch/v1/projects/{projectId}/whatsapp/senders/{senderId}

Request

  • Base URL
    https://provisioning.api.sinch.com
  • URL
    https://provisioning.api.sinch.com/v1/projects/{projectId}/whatsapp/senders/{senderId}
  • Auth
    HTTP basic and HTTP bearer and OAuth 2
    Client credentials
    Token URL: https://auth.sinch.com/oauth2/token

Path parameters

projectIdstring required

The unique ID of the project. You can find this on the <a href="https://dashboard.sinch.com/">Sinch Dashboard</a>.

senderIdstring required

The unique ID of the sender.

Request body

status'DRAFT' | 'SUBMIT'

Create as draft or submit. Defaults to draft.

Response

Updated sender in project

idstring required

The unique ID of the sender.

state'ACTIVE' | 'IN_PROGRESS' | 'INACTIVE' | 'PENDING_VERIFICATION' | 'SUSPENDED' | 'ERROR'

The current state of the sender.

region'BR' | 'EU' | 'US' | 'UNRECOGNIZED' required

Region sender is provisioned in.

metaLocalStorage'AE' | 'AU' | 'BH' | 'BR' | 'CA' | 'CH' | 'DE' | 'GB' | 'ID' | 'IN' | 'JP' | 'KR' | 'SG' | 'US' | 'ZA' | 'UNRECOGNIZED' | 'UNSPECIFIED' required

Region sender store the data in Meta.

conversationApiAppstring

If set, the Conversation API App ID the sender is connected to.

maxTpsnumber

Maximum sender TPS.

qualityRating'GREEN' | 'RED' | 'YELLOW' | 'UNKNOWN' | 'UNRECOGNIZED'

Current quality rating of the sender.

dailyLimit'NOT_SET' | 'TIER_100K' | 'TIER_10K' | 'TIER_1K' | 'TIER_250' | 'TIER_2K' | 'TIER_50' | 'TIER_UNLIMITED' | 'UNRECOGNIZED'

This property is deprecated. Use AccountDto.businessDailyLimit instead. Current daily message limit of the sender.

bearerTokenstring

Bearer token of the sender. The bearer token is needed to connect the sender to a Conversation API App.

cloudApiboolean required

True if the sender is hosted in WhatsApp Cloud API.

createdstring

The UTC Date Time in ISO 8601 for when the sender was created.

modifiedstring

The UTC Date Time in ISO 8601 for when the sender was last modified.

countryCodestring

Country code of sender phone number.

phoneNumberstring

Sender phone number without country code.

numberProvider'CUSTOMER' | 'SINCH' | 'UNRECOGNIZED'

Provider for phone number.

businessManager'SINCH_AMERICA' | 'SINCH_BR' | 'SINCH_MX' | 'SINCH_SEP' | 'SINCH_UK' | 'UNRECOGNIZED' required

Business manager.

wabaBanState'DISABLE' | 'REINSTATE' | 'SCHEDULE_FOR_DISABLE' | 'UNRECOGNIZED'

Please use get account endpoint for this information.

wabaBanDatestring

Please use get account endpoint for this information.

compatibleRegionsWhatsappConversationAppRegionsEnum[] required

Conversation API app regions the sender can be used for.

Changes

  • e0d5694e709dRevision changes
    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • info

      request property ///// list-of-types was widened by adding types null to media type application/json

    • info

      request property ///// list-of-types was widened by adding types null to media type application/json

    • info

      request property ///// list-of-types was widened by adding types null to media type application/json

    • info

      request property ///// list-of-types was widened by adding types null to media type application/json

    • info

      request property ///// list-of-types was widened by adding types null to media type application/json

    • info

      request property ///// list-of-types was widened by adding types null to media type application/json

    • info

      request property ///// list-of-types was widened by adding types null to media type application/json

    • info

      request property ///// list-of-types was widened by adding types null to media type application/json

  • 3f8305bf3748Revision changes
    • info

      added the new optional request property /////

    • info

      removed the non-success response with the status