api:destination:special:update
Table of Contents
API : Special destination Update
Introduction
This request will update an existing special destination. Only the fields present in the body are updated; a blank name is ignored.
Request
| URL | https://api.telecomx.dk/destination/special/PREFIX | ||
|---|---|---|---|
| Method | POST | ||
| Access level | RESELLER_ADMIN with FINANCE feature, or ADMIN. | ||
| Param | PREFIX | Prefix (id) of the special destination, e.g. +4590123456. The + must be URL encoded as %2B. | |
| Body | name | String | [optional] Name of the service offered. |
| fee | Number | [optional] Connection fee, 0-100000. |
|
| rate | Number | [optional] Pr. minute rate, 0-100000. |
|
| vatExemption | Boolean | [optional] True if the call is VAT free. |
|
Request body example
{ "fee": 2, "rate": 1.25 }
Response
The updated special destination is returned.
| JSON object | ||
|---|---|---|
| _id | String | Prefix of the Danish special number. |
| name | String | Name of the service offered. |
| fee | Number | Connection fee. |
| rate | Number | Pr. minute rate. |
| vatExemption | Boolean | True if the call is VAT free. |
Example
{ "_id": "+4590123456", "name": "Example fundraising show", "fee": 2, "rate": 1.25, "vatExemption": true }
Errors
| Error code | Message | Description |
|---|---|---|
| 422 | id | Prefix is not valid |
| 404 | not_found | Special destination not found |
| 422 | name | Name is not valid |
| 422 | fee | Fee is not valid |
| 422 | rate | Rate is not valid |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/destination/special/update.txt · Last modified: by Mikkel Meerwaldt Jørgensen