JSON API » mailboxes » mailboxes/destinations/set

Sets the secondary destinations for a mailbox.

Input parameters

Requires authentication and the administrator, residential, or user role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
mailbox	Integer	ID of mailbox.	Yes
customer	Integer	ID of customer owning mailbox.	No	Customer of authentication user.
destinations	String	Secondary destination mailboxes, separated by commas. Empty string for none.	No	Empty string.
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
201	Input passed validation. Only returned if validation=1.
204	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
403	Your rate plan does not allow this.
404	The mailbox does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/mailboxes/destinations/set/?auth_username=user;auth_password=password;mailbox=1234;destinations=1235,1236

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
3.13	Function added.