WhatsApp Senders

Register sender for project

Changed on
Triggers sender registration with the requested method. An OTP code will be sent over the requested method that will need to be used in the Verify sender endpoint.
post/v1/projects/{projectId}/whatsapp/senders/{senderId}/register

Request

  • Base URL
    https://provisioning.api.sinch.com
  • URL
    https://provisioning.api.sinch.com/v1/projects/{projectId}/whatsapp/senders/{senderId}/register
  • 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

method'SMS' | 'VOICE' required

Registration Method of the sender.

Response

idstring required

The unique ID of the sender.

method'SMS' | 'VOICE' | 'UNRECOGNIZED' required

Registration Method of the sender.

acceptedstring required

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

verificationCodeSentboolean required

Whether the verification code has been sent.

Changes

    • breaking

      added to the request property allOf list

    • breaking

      removed the enum value SMS of the request property

    • breaking

      removed the enum value VOICE of the request property

    • breaking

      the request property type changed from string to no type

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's property type changed from string to no type for status

    • info

      removed subschema #1: InvalidInputErrorTitle subschema #2: ProjectNotInitializedErrorTitle subschema #3: InvalidPayloadErrorTitle from the response body oneOf list for the response status

    • info

      removed subschema #1: NotAllowedRegisterErrorTitle subschema #2: SenderNumberNotApprovedForEnterpriseErrorTitle from the response body oneOf list for the response status

    • info

      removed subschema #1: SenderRegisterTooManyRequestsErrorTitle subschema #2: SenderAlreadyRegisteredErrorTitle subschema #3: TooManyInvalidVerificationCodesErrorTitle from the response body oneOf list for the response status

    • 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

    • 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

    • info

      added to the response property allOf list for the response status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      removed the SMS enum value from the response property for the response status

    • info

      removed the UNRECOGNIZED enum value from the response property for the response status

    • info

      removed the VOICE enum value from the response property for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      api operation id SendersController_register_v1 removed and replaced with WhatsappSendersController_register_v1