API URL
Acceptable request type
Post
1.1 Parameters
Headers:
Parameter | Description | Appearance | Explanation |
apiKey | string | required | A unique key for each club |
Body:
Parameter | Description | Appearance | Explanation |
first_name | string | required | Lead’s first name |
last_name | string | optional | Lead’s last name |
phone | string | required | Lead’s contact number |
string | required | Lead’s contact email | |
location_box_fk | Int, (location must be connected to box) | required | System number - studio’s place |
status_fk | Int (number) | optional | System number - lead’s status at which it will appear after filling out the form. |
source_fk | Int (number) | optional | System number - the landing page from which the lead generated. |
comment | string | optional | Any additional parameter can be used here. |
allow_sms | Enum = yes, no | optional | Case sensitive (Use lower case) |
allow_mailing_list | Enum = yes, no | optional | Case sensitive (Use lower case) |
Request sample on Postman
Response
1.2 Successful response sample:
{ "statusCode": 200, "data": { "id": 53736, "first_name": "Ella", "last_name": "Fish", "phone": 05239348583 "email": "talky@talk.8200" } } |
1.3 Error code list
Integer | Name | Description |
500 | INTERNAL SERVER ERROR | An unexpected server error occurs. |
400 | INVALID FORM REQUEST | One or more of your form values are not valid |
400 | INVALID API USER | The user connected with the API is invalid |
401 | NO API KEY | Please supply an access token |
401 | INVALID API KEY | Please provide a valid access token |
401 | NOT UNIQUE API KEY | Issued access token, please contact ARBOX |