Skip to main content
POST
/
notifications
cURL
curl --request POST \
  --url https://api.example.com/notifications \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalId": "<string>",
  "type": "EMAIL",
  "reason": "<string>",
  "metadata": {}
}
'
{
  "tenantId": "<string>",
  "id": "<string>",
  "type": "EMAIL",
  "status": "SENT",
  "provider": "AR24",
  "createdAt": "2023-11-07T05:31:56Z",
  "externalId": "<string>",
  "reason": "<string>",
  "metadata": {},
  "updatedAt": "2023-11-07T05:31:56Z"
}

Body

application/json
externalId
string
required
type
enum<string>
required
Available options:
EMAIL,
LRE,
ERE
reason
string
metadata
object

Response

200 - application/json
tenantId
string
required
id
string
required
type
enum<string>
required
Available options:
EMAIL,
LRE,
ERE
status
enum<string>
required
Available options:
SENT,
OPENED,
REJECTED,
NEGLECTED
provider
enum<string>
required
Available options:
AR24,
CUSTOMER_IO
createdAt
string<date-time>
required
externalId
string
reason
string
metadata
object
updatedAt
string<date-time>