WhatsApp Templates

List all templates in project

Changed on
Returns a paginated list of templates for the specified project. If no page token is supplied then the first `50` templates are returned in alphabetical order.
get/v1/projects/{projectId}/whatsapp/templates

Request

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

Query parameters

pageTokenstring

The page token if retrieving the next page from a previous query.

pageSizenumber

The page size requested.

fieldMaskWhatsappTemplateDtoFieldMaskPathsEnum[]

Field masks are a way for API callers to list the fields that a request should return.

filterStatesWhatsappTemplateStatesEnum[]

Optionally query for sender by states.

filterStatusesWhatsappTemplateStatusesEnum[]

Optionally query for sender by statuses.

templateAnalyticsDateRange'DAY' | 'MONTH' | 'QUARTER' | 'WEEK'

The date range to retrieve template analytics for. Fallback to DAY if none is set.

templateNamestring

Optionally query for template by name. Will return all templates with names that begin with the query string.

Response

List of templates

OR

Changes

    • info

      added the enum value changes.details.optimization to the property items/ of the query request parameter fieldMask

    • info

      added the enum value details.optimization to the property items/ of the query request parameter fieldMask

    • 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 the enum value changes.details.components.0.hasExpiration to the property items/ of the query request parameter fieldMask

    • info

      added the enum value details.components.0.hasExpiration to the property items/ of the query request parameter fieldMask

    • info

      added to the ///////////////// response property anyOf list for the response status

    • info

      added to the ///////////////// response property anyOf list for the response status

    • info

      added to the ///////////////// response property anyOf list for the response status

    • info

      added to the //////////// response property anyOf list for the response status

    • info

      added to the ///////////////// response property anyOf list for the response status

    • info

      added to the //////////// response property anyOf list for the response status