# Request a message dispatch

**POST /v1/api/dispatch**

It creates a multi-channel and multi-language message for multiple recipients. Please note that there is a limit of 1000 recipients per request.


## Servers
- API Server Host: https://api.nifteem.com (API Server Host)


## Authentication methods
- X api key


## Parameters



### Body: application/json (object)
Dispatch request payload
- **message** (object)
  Multilanguage, multichannel message. Required if template is not specified
- **template** (object)
  Required if message is not specified
- **recipients** (array[object])

- **scheduleDate** (string(date-time))
  Optional scheduled date and time for a deferred message delivery in UTC format (e.g., 'yyyy-MM-dd'T'HH:mm:ss'Z'). Must be in the future and no more than 365 days from the current date. If null, the message will be sent immediately and cannot be cancelled. A scheduled dispatch can be cancelled only up to 5 minutes before the specified date and time.
- **countryCodeFixEnabled** (boolean)
  Set true if you want to fix msisdn numbers with the countryCodeDefault. If numbers in the recipient list don't have interational prefix, set this flag to true otherwise recipients with invalid numbers will be skipped.
- **countryCodeDefault** (string)
  Required if countryCodeFixEnabled is true
- **channels** (object)
  Channels parameters. Required if message is specified, ignored for template.
- **metadata** (object)
  Optional custom metadata linked to the dispatch. Sent as 'dispatchMetadata' parameter of "Message Status Update" webhook.
- **webhookUrl** (string)
  Optional URL to which status updates for sent messages will be delivered as webhook callbacks. The URL must use the HTTPS protocol to ensure secure communication.
- **webhookSecret** (string)
  Optional secret key used to sign webhook callbacks. If provided, each webhook request will include a signature header computed using HMAC-SHA256 with this secret, allowing the recipient to verify the integrity and authenticity of the payload.


## Responses
### 200
Message successfully sent

#### Body: application/json (string)
string
### 401
Unauthorized

### 403
Forbidden

### 400
Bad Request

### 500
Internal Server Error


[Powered by Bump.sh](https://bump.sh)