Add a subscriber to segmentation lists

POST 
/segmentation/add-subscriber/:email

Add a subscriber to segmentation lists by email

Request

Path Parameters

email stringrequired

Subscriber email address

Header Parameters

x-api-key stringrequired

Your API key

x-developer-mode boolean

Enable developer mode. Learn more here.

application/json

Body

segmentationLists string[]

List of segmentation lists IDs. You can get the ID by calling our support team.

Responses

200

Subscriber added to segmentation list

application/json

Schema

Schema

requestId string
data object[]
Array [
id string
email string
subscriberId string
segmentationListId string
createdAt date-time
updatedAt date-time
]

Example (from schema)

{
  "requestId": "string",
  "data": [
    {
      "id": "string",
      "email": "string",
      "subscriberId": "string",
      "segmentationListId": "string",
      "createdAt": "2024-07-29T19:44:36.658Z",
      "updatedAt": "2024-07-29T19:44:36.658Z"
    }
  ]
}

400

Bad request

application/json

Schema

Schema

anyOf
Body is necessary
error string
errorCode string
requestId string
Subscriber not enabled
error string
errorCode string
requestId string

Example (from schema)

{}

404

Not found

application/json

Schema

Schema

anyOf
Subscriber not found
error string
errorCode string
requestId string
Segmentation list not found
error string
errorCode string
requestId string

Example (from schema)

{}

422

Unprocessable Entity

application/json

Schema

Schema

anyOf
Subscriber email is necessary
error string
errorCode string
requestId string
Unprocessable Entity
error string
errorCode string
requestId string

Example (from schema)

{}

500

Internal server error.

application/json

Schema

Schema

error string
errorCode string
requestId string

Example (from schema)

{
  "error": "Internal server error.",
  "errorCode": "INTERNAL_SERVER_ERROR",
  "requestId": "ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f"
}

Loading...