Sign in

Welcome.
How can we help?

Developer API: /customers

Topic: , Updated:

This resource is used to handle new or existing customers. Please see the note on paging.

GET

Mandatory parameters

None.

Optional parameters

NameTypeDescription
customer_id int Freespee's unique ID for customer.
custnr string Partners unique customer number / ID.

Output

NameTypeDescription
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.
email 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

NameTypeDescription
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

NameTypeDescription
email string Customer email address, 45 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.

Output

Same as GET.

PUT

Mandatory parameters

NameTypeDescription
customer_id int Freespee's unique ID for customer.

Optional parameters

NameTypeDescription
name string Customer name.
custnr string Partners unique customer number / ID.
email 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.

Output

Same as GET.

DELETE

Method not supported.

Was this article helpful?
0 out of 0 found this helpful

Comments


Not the answer to your question?

Powered by Zendesk