latestOpenAPI 3.0.02026-08-10171532.2 KB

c6c3717d477d

Recipient

Create a recipient

post/recipients

Request body

namestring

Name of the recipient. Primarely used for your reference, but acts as a fallback when you use the "name" placeholder

emailstring

Emailaddress of the recipient

mailinglistsstring[]

Example request

{
  "name": "John Doe",
  "email": "john@company.com",
  "filters": [
    {
      "id": "temp-key-234",
      "key": "Region",
      "value": "North"
    }
  ],
  "placeholders": [
    {
      "key": "name",
      "value": "John Doe"
    }
  ]
}

Response

Store a new recipient

namestring

Name of the recipient. Primarely used for your reference, but acts as a fallback when you use the "name" placeholder

emailstring

Emailaddress of the recipient

mailinglistsstring[]

created_atstring

Created at timestamp

updated_atstring

Updated at timestamp

Example response

{
  "name": "John Doe",
  "email": "john@company.com",
  "filters": [
    {
      "id": "temp-key-234",
      "key": "Region",
      "value": "North"
    }
  ],
  "placeholders": [
    {
      "key": "name",
      "value": "John Doe"
    }
  ],
  "created_at": "2024-01-17T09:45:14.000000Z",
  "updated_at": "2024-01-17T09:45:14.000000Z"
}