Skip to content

mail_recipient

Manage mail recipients

Create

Path
POST /v7.0/mail_recipients
Description
Create a mail recipient
Authentication required
yes
Scope
mail_recipient#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
mail_recipient
ParameterTypeRequiredDetails
label
Label
 String no

Human-friendly label

Default: null
to
To
 String no

Default: null
cc
Cc
 String no

Default: null
bcc
Bcc
 String no

Default: null

Output parameters

Layout
object
Namespace
mail_recipient
ParameterTypeDescription
id
Id
 Integer
label
Label
 String Human-friendly label
to
To
 String
cc
Cc
 String
bcc
Bcc
 String

Delete

Path
DELETE /v7.0/mail_recipients/{mail_recipient_id}
Description
Delete a mail recipient
Authentication required
yes
Scope
mail_recipient#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/mail_recipients
Description
List mail recipients
Authentication required
yes
Scope
mail_recipient#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
mail_recipient
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000

Output parameters

Layout
object_list
Namespace
mail_recipients
ParameterTypeDescription
id
Id
 Integer
label
Label
 String Human-friendly label
to
To
 String
cc
Cc
 String
bcc
Bcc
 String

Show

Path
GET /v7.0/mail_recipients/{mail_recipient_id}
Description
View mail recipient
Authentication required
yes
Scope
mail_recipient#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
mail_recipient
ParameterTypeDescription
id
Id
 Integer
label
Label
 String Human-friendly label
to
To
 String
cc
Cc
 String
bcc
Bcc
 String

Update

Path
PUT /v7.0/mail_recipients/{mail_recipient_id}
Description
Update a mail recipient
Authentication required
yes
Scope
mail_recipient#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
mail_recipient
ParameterTypeRequiredDetails
label
Label
 String no

Human-friendly label

Default: null
to
To
 String no

Default: null
cc
Cc
 String no

Default: null
bcc
Bcc
 String no

Default: null

Output parameters

Layout
object
Namespace
mail_recipient
ParameterTypeDescription
id
Id
 Integer
label
Label
 String Human-friendly label
to
To
 String
cc
Cc
 String
bcc
Bcc
 String