POST /loyalty/balance/programs/{pid}/transactions
Creates new transaction and returns information
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 |
|---|---|---|---|
ttl |
Integer | No |
Time-to-live for the transaction in seconds. Must be at least 10 seconds if provided. |
eventTime |
String | No |
Timestamp specifying when the transaction event occurred (ISO 8601 / RFC 3339 format). |
transactionType |
String | No |
Explicit transaction type. If not provided, the type is inferred from the sign of the amount (positive = credit, negative = debit). Valid values:
|
LoyaltySubscriptionId |
String | No |
Unique identifier for the loyalty subscription. Required unless |
autoComplete |
Boolean | No |
Whether the transaction should be automatically completed. |
balanceDefinitionId |
String | Yes |
Unique identifier (UUID) of the associated balance definition. |
amount |
Number | Yes |
Transaction amount. A positive value creates a credit transaction and a negative value creates a debit transaction (unless transactionType is explicitly provided). |
balanceExpiryInMinutes |
Integer | No |
Expiry time for the balance in minutes. Must be greater than 0 if provided. Only applicable when autoComplete is true. |
meta |
Object | No |
Optional metadata associated with the transaction. |
contactId |
Integer | No |
Unique identifier of the contact involved in the transaction. Required unless |
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.