This API allows you to create a custom segment run in Releva. You can then use this segment run, a custom campaign, and a custom email, to send emails via API.

Request Parameters #

You may perform requests to the API using the following curl equivalent:

curl -H 'content-type: application/json' -H 'authorization: Bearer <secretKey>' -XPOST 'https://releva.ai/api/v0/segmentRuns' -d'{"segmentId": <id>}'

Request Body #

Response Format #

A successful response will return HTTP Status 200 and a JSON body with the following structure. You will need the segmentRunId in order to send emails.

{
  "segmentRunId": "...",
}

An error response will return a HTTP 4xx or 5xx status code and have the following structure:

{
  "message": "A description of the error and how to fix it, if it's a client error."
}