This resource is used to handle new or existing customers. Please see the note on paging.
GET
Mandatory parameters
None.
Optional parameters
| Name | Type | Description |
|---|---|---|
| customer_id | int | Freespee's unique ID for customer. |
| custnr | string | Partners unique customer number / ID. |
Output
| Name | Type | Description |
|---|---|---|
| customer_id | int | Freespee's unique ID for customer. |
| name | string | Customer name. |
| custnr | string | Partners unique customer number / ID. |
| corporateid | string | Customer corporate number / ID, e.g. VAT-number. |
| string | Customer email address. | |
| uuid | string | Customer unique ID. |
| custom_N | string | Customer custom field value where N between 1 and 20, 255 characters. |
| receive_monthly_report | int | Customer to receive monthly report, 0=no report, 1=extended, 2=short. |
| freespee_caller_id | int | Customer to receive Freespee number as CLI, 1=true, 0=false. |
POST
Mandatory parameters
| Name | Type | Description |
|---|---|---|
| name | string | Customer name, 60 characters. |
| custnr | string | Partners unique customer number / ID, 45 characters. |
For our partners operating in Germany, please see the following note on creating customers.
Optional parameters
| Name | Type | Description |
|---|---|---|
| string | Customer email address, 150 characters. | |
| corporateid | string | Customer corporate number / ID, e.g. VAT-number, 40 characters. |
| custom_N | string | Customer custom field value where N between 1 and 20, 255 characters. * |
| receive_monthly_report | int | Customer to receive monthly report, 0=no report, 1=extended, 2=short. |
| freespee_caller_id | int | Customer to receive Freespee number as CLI, 1=true, 0=false. |
| whisper | int | Whisper active on the account, 1 = on, 0 = off. |
* Custom_N fields has to be setup by Freespee support before being able to store data in it.
Output
Same as GET.
PUT
Mandatory parameters
| Name | Type | Description |
|---|---|---|
| customer_id | int | Freespee's unique ID for customer. |
Optional parameters
| Name | Type | Description |
|---|---|---|
| name | string | Customer name. |
| custnr | string | Partners unique customer number / ID. |
| string | Customer email address. | |
| corporateid | string | Customer corporate number / ID, e.g. VAT-number. |
| custom_N | string | Customer custom field value where N between 1 and 20, 255 characters. |
| receive_monthly_report | int | Customer to receive monthly report, 0=no report, 1=extended, 2=short. |
| freespee_caller_id | int | Customer to receive Freespee number as CLI, 1=true, 0=false. |
| whisper | int | Whisper active on the account, 1 = on, 0 = off. |
Output
Same as GET.
DELETE
Mandatory parameters
| Name | Type | Description |
|---|---|---|
| customer_id | int | Freespee's unique ID for customer. |
After this request is made, the account will be marked as removed and all measures will be expired. It will remove any users and allowed numbers. It will replace all phone numbers with the ccndc of the number and remove the subscriber number with asterisks. Any extra personal data is simply just removed.