HomepageBlog

Email

Return list of recipients

get

API Key Scope: recipients / index

Authorizations
Responses
200

List of recipient.

application/json
get
/email/recipients
GET /api/v2/email/recipients HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
200

List of recipient.

{
  "count": 1,
  "recipients": [
    {
      "email_id": "text",
      "activation": 1,
      "email_address": "text",
      "severity_low": 1,
      "severity_high": 1
    }
  ]
}

Creates a new recipient.

post

API Key Scope: recipients / create

Authorizations
Body
email_idstringOptional
activationintegerOptional
email_addressstringOptional
severity_lowintegerOptional
severity_highintegerOptional
Responses
201

A specific recipient.

application/json
post
/email/recipients
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
}

Displays a specific recipient.

get

API Key Scope: recipients / show

Authorizations
Path parameters
email_idstringRequired

Numeric ID of email recipient.

Responses
200

A specific recipient.

application/json
get
/email/recipients/{email_id}
GET /api/v2/email/recipients/{email_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
200

A specific recipient.

{
  "email_id": "text",
  "activation": 1,
  "email_address": "text",
  "severity_low": 1,
  "severity_high": 1
}

Updates a specific recipient with his relations.

put

API Key Scope: recipients / update

Authorizations
Path parameters
email_idstringRequired

Numeric ID of email recipient.

Body
email_idstringOptional
activationintegerOptional
email_addressstringOptional
severity_lowintegerOptional
severity_highintegerOptional
Responses
200

A specific recipient.

application/json
put
/email/recipients/{email_id}
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
}

Destroys a specific recipient.

delete

API Key Scope: recipients / destroy

Authorizations
Path parameters
email_idstringRequired

Numeric ID of email recipient.

Responses
204

Recipient destroyed.

No content
delete
/email/recipients/{email_id}
DELETE /api/v2/email/recipients/{email_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
204

Recipient destroyed.

No content

Return relay server infos

get

API Key Scope: relay_server / show

Authorizations
Responses
200

relay server infos.

application/json
get
/email/relay_server
GET /api/v2/email/relay_server HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
200

relay server infos.

{
  "server": "text",
  "sender": "text",
  "user": "text",
  "password": "text"
}

Updates relay server infos.

put

API Key Scope: relay_server / update

Authorizations
Body
serverstringOptional
senderstringOptional
userstringOptional
passwordstringOptional
Responses
200

relay server infos.

application/json
put
/email/relay_server
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?