Skip to main content
POST
/
api
/
v1
/
segments
/
{segmentId}
/
members
Add members to a segment
curl --request POST \
  --url https://api.railmail.app/api/v1/segments/{segmentId}/members \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "subscriberIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "errors": {}
}

Authorizations

​
X-API-Key
string
header
required

Project-scoped API key, format rm_(live|test)_... . May also be sent as Authorization: Bearer rm_....

Path Parameters

​
segmentId
string<uuid>
required

Segment id (UUID).

Body

application/json
​
subscriberIds
string<uuid>[]
required
Minimum array length: 1

Response

Members added