POST /loyalty/balance/programs/{pid}/create-order
Returns created order
Servers
- https://api.brevo.com/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
pid |
String | Yes |
Loyalty Program Id |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
source |
String | Yes |
Specifies the origin of the order ( |
expiresAt |
String | No |
Optional RFC3339 timestamp defining order expiration. |
balanceDefinitionId |
String | Yes |
Unique identifier (UUID) of the associated balance definition. |
amount |
Number | Yes |
Order amount (must be non-zero). |
meta |
Object | No |
Optional metadata associated with the order. |
dueAt |
String | Yes |
RFC3339 timestamp specifying when the order is due. |
contactId |
Integer | Yes |
Unique identifier of the contact placing the order (must be ≥ 1). |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.