Home > Agendize Scheduling

Clients: insert

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

POST https://api.agendize.com/api/2.0/scheduling/clients

Parameters

Parameter name Value Description
Required query parameters
apiKey string API Key

Request body

In the request body, supply a Client Resource with the following properties:

Parameter name Value Description
Required Properties
lastName string Last name of the client.
Optional Properties
firstName string First name of the client.
email string Email address of the client.
phone string Phone number of the client.
mobilePhone string Mobile phone number of the client.
gender string Gender of the client. Values: "male" or "female". The default value is "male".
timeZone string Time zone of the client. Only if time zone has been specified. Possible values can be found here. The default value is "US/Eastern".
language string Spoken language of the client. Only if client language has been specified. Possible values: "en", "fr", "es", "de", "pt" and "none". The default value is "none". "none" value is the account language.
description string Description of the client.
address object Postal address of the client.
address.street string Main street address.
address.otherStreet string Optional street address.
address.zipCode string Zip code of address.
address.state string State of address.
address.city string City of address.
address.country string Country of address. Possible values can be found here. The default value is "US".
picture object Client picture url and mime type.
picture.url string Url of the client picture.
picture.mimeType string Mime type of the client picture file.

Response

If successful, this method returns a Client resource in the response body.