This resource is used to handle new or existing users.
GET
Mandatory parameters
None.
Optional parameters
Name | Type | Description |
user_id |
int |
Freespee's unique ID for user. |
customer_id |
int |
Freespee's unique ID for customer. |
Output
Name | Type | Description |
user_id |
int |
Freespee's unique ID for user. |
name |
string |
User name. |
write_access |
int |
User write access, 1=true, 0=false. |
receive_monthly_report |
int |
User receives monthly report, 0=no report, 1=extended, 2=short. |
customer_id |
int |
Freespee's unique ID for customer. |
token |
string |
Activation token for user, null if user is activated. |
POST
Mandatory parameters
Name | Type | Description |
email |
string |
User email address, 60 characters. |
customer_id |
int |
Freespee's unique ID for customer. |
Optional parameters
Name | Type | Description |
name |
string |
User name. |
write_access |
int |
User write access, 1=true, 0=false. |
receive_monthly_report |
int |
User receives monthly report, 0=no report, 1=extended, 2=short. |
Output
Same as GET.
PUT
Mandatory parameters
Name | Type | Description |
user_id |
int |
Freespee's unique ID for user. |
Optional parameters
Name | Type | Description |
name |
string |
User name. |
write_access |
int |
User write access, 1=true, 0=false. |
receive_monthly_report |
int |
User receives monthly report, 0=no report, 1=extended, 2=short. |
Output
Same as GET.
DELETE
Mandatory parameters
Name | Type | Description |
user_id |
int |
Freespee's unique ID for user. |
Optional parameters
None.
Output
N/A.