user.mail_role_recipient

Manage user mail recipients

Index

Path: GET /v7.0/users/{user_id}/mail_role_recipients
Description: List user mail role recipients
Authentication required: yes
Scope: user.mail_role_recipient#index
Aliases: list
Blocking: no

Input parameters

Layout: object
Namespace: mail_role_recipient

Parameter Type Required Details

from_id

From ID

Integer

no

List objects with IDs greater or lower than this value

Default: null

Validation rules
Rule	Details
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
Rule	Details
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_role_recipients

Parameter	Type	Description
`id` Id	String
`label` Label	String
`description` Description	String
`to` To	String

Show

Path: GET /v7.0/users/{user_id}/mail_role_recipients/{mail_role_recipient_id}
Description: Show user mail role recipient
Authentication required: yes
Scope: user.mail_role_recipient#show
Aliases: find
Blocking: no

Input parameters

No parameters.

Output parameters

Layout: object
Namespace: mail_role_recipient

Parameter	Type	Description
`id` Id	String
`label` Label	String
`description` Description	String
`to` To	String

Update

Path: PUT /v7.0/users/{user_id}/mail_role_recipients/{mail_role_recipient_id}
Description: Update user mail role recipient
Authentication required: yes
Scope: user.mail_role_recipient#update
Aliases
Blocking: no

Input parameters

Layout: object
Namespace: mail_role_recipient

Parameter	Type	Required	Details
`to` To	String	no	Default: `null`

Output parameters

Layout: object
Namespace: mail_role_recipient

Parameter	Type	Description
`id` Id	String
`label` Label	String
`description` Description	String
`to` To	String