Users

post
Create A User

https://app.bookboost.io/api/v2/apps/{appId}/users
Request
Response
Request
Body Parameters
tags
optional
array
an array of tags you want to tag the user with
attributes
optional
array
specify gender, title and salutation
locale
optional
array
specify country_code and language_code
last_name
optional
string
Last name of user
first_name
optional
string
First name of user
phone
optional
string
E164 formatted phone number like +31 6 123 432 32
email
optional
string
email address
Response
200: OK
Cake successfully retrieved.
{
"first_name": "John",
"last_name": "Doe",
"updated_at": "2019-12-19 21:55:20",
"created_at": "2019-12-19 21:55:20",
"id": 540,
"validPhone": true,
"phone": "+31612343232",
"email": "[email protected]",
"avatarUrl": null,
"locale": {
"id": 105,
"user_id": 540,
"country_code": "SE",
"language_code": "sv_SV"
},
"attributes": [
{
"user_id": 540,
"title": "Sir Mr",
"gender": "Male",
"salutation": "Dear"
}
],
"phones": [
{
"id": 165,
"user_id": 540,
"ptt": null,
"plt": null,
"number": "+31612343232",
"raw": "+31 6 123 432 32",
"is_primary": true,
"client_id": null,
"integration_id": null,
"created_at": "2019-12-19 21:55:20",
"updated_at": "2019-12-19 21:55:20",
"cca2": "NL",
"source": null
}
],
"emails": [
{
"id": 243,
"user_id": 540,
"type_code": null,
"address": "[email protected]",
"is_primary": true,
"client_id": null,
"integration_id": null,
"created_at": "2019-12-19 21:55:20",
"updated_at": "2019-12-19 21:55:20",
"source": null
}
]
}

put
Update A User

https://app.bookboost.io/api/v2/v2/apps/{appId}/users/{userId}
Request
Response
Request
Body Parameters
tags
optional
array
an array of tags to associate with the user
attributes
optional
array
specify gender, title and salutation
locale
optional
array
specify country_code and language_code
first_name
optional
string
First name of user
last_name
optional
string
Last name of user
phone
optional
string
E164 formatted phone number . like +31 6 23923 83
email
optional
string
Email Address
Response
200: OK
{
"first_name": "John",
"last_name": "Doe",
"updated_at": "2019-12-19 21:55:20",
"created_at": "2019-12-19 21:55:20",
"id": 540,
"validPhone": true,
"phone": "+31612343232",
"email": "[email protected]",
"avatarUrl": null,
"locale": {
"id": 105,
"user_id": 540,
"country_code": "SE",
"language_code": "sv_SV"
},
"attributes": [
{
"user_id": 540,
"title": "Sir Mr",
"gender": "Male",
"salutation": "Dear"
}
],
"phones": [
{
"id": 165,
"user_id": 540,
"ptt": null,
"plt": null,
"number": "+31612343232",
"raw": "+31 6 123 432 32",
"is_primary": true,
"client_id": null,
"integration_id": null,
"created_at": "2019-12-19 21:55:20",
"updated_at": "2019-12-19 21:55:20",
"cca2": "NL",
"source": null
}
],
"emails": [
{
"id": 243,
"user_id": 540,
"type_code": null,
"address": "[email protected]",
"is_primary": true,
"client_id": null,
"integration_id": null,
"created_at": "2019-12-19 21:55:20",
"updated_at": "2019-12-19 21:55:20",
"source": null
}
]
}