Delete Segment Run

Updated on October 2, 2024

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>' -XDELETE 'http://localhost/api/v0/segmentRuns/<segmentRunId>'

Request URL Parameters #

FieldTypeDescription
segmentRunIdIntegerThe id of the segment run to delete. Must be an Id created using the Create Segment Run API

Response Format #

A successful response will return HTTP Status 204 and an empty JSON body.

{}

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."
}