Bundles

Create bundle for project

Changed on
Creates a new bundle of resources based on the input work order.
post/v1/projects/{projectId}/bundles

Request

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

Request body

namestring

Name of bundle to create. If a name is not specified in the resource blocks then they will be created with this name.

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

Region to create resources in. (Allowed values for staging environment: EU or US).

Example request

{
  "name": "Sample bundle"
}

Response

Responds with the bundle created. At time of response the bundle might not be completed. To receive the complete payload register a webhook for the BUNDLE_DONE trigger.

idstring required

Id of bundle created.

projectIdstring required

The project or subproject id where resources have been created.

namestring

Name of bundle created. If a name was not specified in the resource blocks then they were created with this name.

state'DONE' | 'FAILED' | 'IN_PROGRESS' required

Current state.

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

Region resources were create in.

Changes

    • info

      added the new optional request property /////////

    • warning

      added the new WHATSAPP_SENDER_DISPLAY_NAME_UPDATED enum value to the /// response property for the response status

    • info

      added the new WHATSAPP_SENDER_DISPLAY_NAME_UPDATED enum value to the request property ///////