Name | Type | Read/Write | Description |
---|---|---|---|
id | Integer | Read | Contact’s id. |
String | Read | Contact’s email address. | |
website | String | Read | Contact’s website url. |
private_notes | String | Read | Contact’s annotations. |
gender | String | Read | Contact’s gender. List of possible values described in enums section. |
firstname | String | Read | Contact’s firstname |
lastname | String | Read | Contact’s lastname |
fullname | String | Read | Contact’s fullname |
address1 | String | Read | Contact’s address |
address2 | String | Read | extension of Contact’s address |
city | String | Read | Contact’s city |
country_code | String | Read | Contact’s country code, list of codes is available at wikipedia. |
state | String | Read | Contact’s state |
zip | String | Read | Contact’s zip code |
spoken_languages | Array | Read | List of all available languages is described in enums section. |
phones | Array of Object | Read | Contact’s phones |
created_at | Time | Read | Contact’s create time. |
updated_at | Time | Read | Contact’s update time. |
canceled_at | Time | Read | Contact’s cancel time. |
forget_me_at | Time | Read | Contact’s forget time. |
processing_restricted_at | Time | Read | Contact’s processing restriction time. |
Name | Type | Read/Write | Description |
---|---|---|---|
id | Integer | Read | Contact’s id. |
String | Read/Write | Contact’s email address. | |
website | String | Read/Write | Contact’s website url. |
private_notes | String | Read/Write | Contact’s annotations. |
gender | String | Read/Write | Contact’s gender. List of possible values described in enums section. |
firstname | String | Read/Write | Contact’s firstname |
lastname | String | Read/Write | Contact’s lastname |
fullname | String | Read | Contact’s fullname |
address1 | String | Read/Write | Contact’s address |
address2 | String | Read/Write | extension of Contact’s address |
city | String | Read/Write | Contact’s city |
country_code | String | Read/Write | Contact’s country code, list of codes is available at wikipedia. |
state | String | Read/Write | Contact’s state |
zip | String | Read/Write | Contact’s zip code |
spoken_languages | Array | Read/Write | List of all available languages is described in enums section. |
phones | Array of Object | Read/Write | Contact’s phones |
created_at | Time | Read | Contact’s create time. |
updated_at | Time | Read | Contact’s update time. |
canceled_at | Time | Read | Contact’s cancel time. |
forget_me_at | Time | Read | Contact’s forget time. |
processing_restricted_at | Time | Read | Contact’s processing restriction time. |
List all contacts for a given account(s).
GET /contacts
{
"links": {
"contacts.account": "https://www.bookingsync.com/api/v3/accounts/{contacts.account}"
},
"contacts": [
{
"id": 1,
"address1": "Nilsa Crossroad",
"address2": null,
"city": "New Margarettafurt",
"country_code": "US",
"email": "cornelia@nienow.co.uk",
"firstname": "FirstName1",
"fullname": "FirstName1 LastName1",
"gender": "male",
"lastname": "LastName1",
"phones": [
{
"label": "phone",
"number": "+33 (0)6 123.123.123"
},
{
"label": "mobile",
"number": "+33 (0)6 123.123.123"
},
{
"label": "fax",
"number": "+33 (0)6 123.123.123"
}
],
"private_notes": "Lorem",
"spoken_languages": [
"en",
"fr"
],
"state": "Nevada",
"website": "http://example.com",
"zip": "44147",
"created_at": "2021-01-22T08:40:20Z",
"updated_at": "2021-01-22T08:40:20Z",
"canceled_at": null,
"forget_me_at": null,
"processing_restricted_at": null,
"links": {
"account": 1
}
}
],
"meta": {
"Link": {
"first": "https://www.bookingsync.com/api/v3/contacts?page=1",
"last": "https://www.bookingsync.com/api/v3/contacts?page=1"
},
"X-Per-Page": "100",
"X-Total-Count": "1",
"X-Total-Pages": "1"
}
}
Returns a single contact identified by ID.
GET /contacts/:contact_id
{
"links": {
"contacts.account": "https://www.bookingsync.com/api/v3/accounts/{contacts.account}"
},
"contacts": [
{
"id": 1,
"address1": "Nilsa Crossroad",
"address2": null,
"city": "New Margarettafurt",
"country_code": "US",
"email": "cornelia@nienow.co.uk",
"firstname": "FirstName1",
"fullname": "FirstName1 LastName1",
"gender": "male",
"lastname": "LastName1",
"phones": [
{
"label": "phone",
"number": "+33 (0)6 123.123.123"
},
{
"label": "mobile",
"number": "+33 (0)6 123.123.123"
},
{
"label": "fax",
"number": "+33 (0)6 123.123.123"
}
],
"private_notes": "Lorem",
"spoken_languages": [
"en",
"fr"
],
"state": "Nevada",
"website": "http://example.com",
"zip": "44147",
"created_at": "2021-01-22T08:40:20Z",
"updated_at": "2021-01-22T08:40:20Z",
"canceled_at": null,
"forget_me_at": null,
"processing_restricted_at": null,
"links": {
"account": 1
}
}
],
"meta": {
"Link": {
"first": "https://www.bookingsync.com/api/v3/contacts?page=1",
"last": "https://www.bookingsync.com/api/v3/contacts?page=1"
},
"X-Per-Page": "100",
"X-Total-Count": "1",
"X-Total-Pages": "1"
}
}
Creates a contact
POST /contacts
{
"contacts": [
{
"address1": "Nilsa Crossroad",
"address2": null,
"city": "New Margarettafurt",
"country_code": "US",
"email": "some@email.com",
"firstname": "FirstName1",
"gender": "male",
"lastname": "LastName1",
"phones": [
{
"label": "phone",
"number": "+33 (0)6 123.123.123"
},
{
"label": "mobile",
"number": "+33 (0)6 123.123.123"
},
{
"label": "fax",
"number": "+33 (0)6 123.123.123"
}
],
"private_notes": "Lorem",
"spoken_languages": [
"en",
"fr"
],
"state": "Nevada",
"website": "http://example.com",
"zip": "44147"
}
]
}
{
"links": {
"contacts.account": "https://www.bookingsync.com/api/v3/accounts/{contacts.account}"
},
"contacts": [
{
"id": 1,
"address1": "Nilsa Crossroad",
"address2": null,
"city": "New Margarettafurt",
"country_code": "US",
"email": "cornelia@nienow.co.uk",
"firstname": "FirstName1",
"fullname": "FirstName1 LastName1",
"gender": "male",
"lastname": "LastName1",
"phones": [
{
"label": "phone",
"number": "+33 (0)6 123.123.123"
},
{
"label": "mobile",
"number": "+33 (0)6 123.123.123"
},
{
"label": "fax",
"number": "+33 (0)6 123.123.123"
}
],
"private_notes": "Lorem",
"spoken_languages": [
"en",
"fr"
],
"state": "Nevada",
"website": "http://example.com",
"zip": "44147",
"created_at": "2021-01-22T08:40:20Z",
"updated_at": "2021-01-22T08:40:20Z",
"canceled_at": null,
"forget_me_at": null,
"processing_restricted_at": null,
"links": {
"account": 1
}
}
],
"meta": {
}
}
Returns an updated contact identified by ID.
PUT /contact/:contact_id
{
"contacts": [
{
"city": "New Margarettafurt",
"private_notes": "Lorem",
"state": "Nevada",
"zip": "44147"
}
]
}
{
"links": {
"contacts.account": "https://www.bookingsync.com/api/v3/accounts/{contacts.account}"
},
"contacts": [
{
"id": 1,
"address1": "Nilsa Crossroad",
"address2": null,
"city": "New Margarettafurt",
"country_code": "US",
"email": "cornelia@nienow.co.uk",
"firstname": "FirstName1",
"fullname": "FirstName1 LastName1",
"gender": "male",
"lastname": "LastName1",
"phones": [
{
"label": "phone",
"number": "+33 (0)6 123.123.123"
},
{
"label": "mobile",
"number": "+33 (0)6 123.123.123"
},
{
"label": "fax",
"number": "+33 (0)6 123.123.123"
}
],
"private_notes": "Lorem",
"spoken_languages": [
"en",
"fr"
],
"state": "Nevada",
"website": "http://example.com",
"zip": "44147",
"created_at": "2021-01-22T08:40:20Z",
"updated_at": "2021-01-22T08:40:20Z",
"canceled_at": null,
"forget_me_at": null,
"processing_restricted_at": null,
"links": {
"account": 1
}
}
],
"meta": {
}
}
Required OAuth scope: :rentals_write
Returns empty response with ‘204 No Content’ status code on success.
DELETE /contacts/:contact_id