api:mailbox:assign
Table of Contents
API : Mailbox Assign
Introduction
This request will assign the files attached to an e-mail message or a fax to a customer as a customer document or to a customers porting as a porting document.
Request
| URL | https://api.telecomx.dk/mailbox/MESSAGE_ID/assign | ||
|---|---|---|---|
| Method | GET | ||
| Access level | RESELLER_ADMIN with PORTING feature. | ||
| Param | MESSAGE_ID | Id of the message (24 hex-char string) | |
| Query | customer | Id | Id of the customer to assign the file(s) to |
| porting | Id | Id of the porting to assign the file(s) to. Multiple portings can also be assigned to, by listing all porting ids in a comma list. | |
Only customer or porting can be set, not both.
Query example
https://api.telecomx.dk/mailbox/1234567890ABCDEF12345678/assign?porting=1234567890ABCDEF12345670 https://api.telecomx.dk/mailbox/1234567890ABCDEF12345678/assign?customer=1234567890ABCDEF12345673 https://api.telecomx.dk/mailbox/1234567890ABCDEF12345678/assign?porting=1234567890ABCDEF12345690,1234567890ABCDEF12345695
Response
| Json object | ||
|---|---|---|
| success | Boolean | True on success |
Example
{ success: true }
Errors
| Error code | Message | Description |
|---|---|---|
| 400 | bad_request | Id not found in request URI |
| 422 | porting | Porting or customer to assign to is missing |
| 404 | id | Message not found |
| 404 | files | Message does not contains any files |
| 404 | customer | Customer not found |
| 409 | porting | Porting is not at the right stage |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/mailbox/assign.txt · Last modified: 2023/10/30 14:04 by Per Møller