API Key Scope: recipients / index
List of recipient.
GET /api/v2/email/recipients HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
List of recipient.
{
"count": 1,
"recipients": [
{
"email_id": "text",
"activation": 1,
"email_address": "text",
"severity_low": 1,
"severity_high": 1
}
]
}API Key Scope: recipients / create
A specific recipient.
The received resource was not correctly formatted.
POST /api/v2/email/recipients HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 92
{
"email_id": "text",
"activation": 1,
"email_address": "text",
"severity_low": 1,
"severity_high": 1
}{
"email_id": "text",
"activation": 1,
"email_address": "text",
"severity_low": 1,
"severity_high": 1
}API Key Scope: recipients / show
Numeric ID of email recipient.
A specific recipient.
The requested resource was not found. The detailed error will be of type not_found.
GET /api/v2/email/recipients/{email_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"email_id": "text",
"activation": 1,
"email_address": "text",
"severity_low": 1,
"severity_high": 1
}API Key Scope: recipients / update
Numeric ID of email recipient.
A specific recipient.
The received resource was not correctly formatted.
PUT /api/v2/email/recipients/{email_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 92
{
"email_id": "text",
"activation": 1,
"email_address": "text",
"severity_low": 1,
"severity_high": 1
}{
"email_id": "text",
"activation": 1,
"email_address": "text",
"severity_low": 1,
"severity_high": 1
}API Key Scope: recipients / destroy
Numeric ID of email recipient.
Recipient destroyed.
No content
DELETE /api/v2/email/recipients/{email_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
Recipient destroyed.
No content
API Key Scope: relay_server / show
relay server infos.
The requested resource was not found. The detailed error will be of type not_found.
GET /api/v2/email/relay_server HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"server": "text",
"sender": "text",
"user": "text",
"password": "text"
}API Key Scope: relay_server / update
relay server infos.
The received resource was not correctly formatted.
PUT /api/v2/email/relay_server HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"server": "text",
"sender": "text",
"user": "text",
"password": "text"
}{
"server": "text",
"sender": "text",
"user": "text",
"password": "text"
}Last updated
Was this helpful?