idnumberrequired
createdAtstring
firstNamestring

Possible values: non-empty

lastNamestring

Possible values: non-empty

externalIdstring

Possible values: non-empty

countrystring

Possible values: non-empty

groups object[]

Possible values: >= 1

Array [

idnumber

contactsnumber

createdAtstring

Possible values: non-empty

namestring

Possible values: non-empty

descriptionstring

isBlacklistboolean

]

addresses objectrequired

All addresses are optional, but at least one address should be provided

msisdnstring

Phone number. We accept both international and national formats (for national you have to specify a country in the dedicated field).

Possible values: non-empty, Value must match regular expression ^\+{0,1}[1-9]{1}[0-9]{6,14}$

weChatUserIdstring

Possible values: <= 128 characters

facebookUserIdstring

Possible values: <= 128 characters

emailstring<email>

Possible values: <= 320 characters

zaloIdstring

Possible values: <= 128 characters

lineIdstring

Possible values: <= 128 characters

kakaoTalkIdstring

Possible values: <= 128 characters

customAttributesobject

{
"id":0,
"createdAt":"string",
"firstName":"string",
"lastName":"string",
"externalId":"string",
"country":"string",
"groups":[
{
"id":0,
"contacts":0,
"createdAt":"string",
"name":"string",
"description":"string",
"isBlacklist":true
}
],
"addresses":{
"msisdn":"string",
"weChatUserId":"string",
"facebookUserId":"string",
"email":"user@example.com",
"zaloId":"string",
"lineId":"string",
"kakaoTalkId":"string"
},
"customAttributes":{}
}

codeintegerrequired

Error code

messagestring

Error description

errorIdstring<uuid>required

Unique id of error. You can use it as reference when sending enquiries to 8x8 support

timestampstring<date-time>required

Data and time of the error occurence

{
"code":1001,
"message":"Provided subAccountId doesn't belongs to your account",
"errorId":"91b106f0-c0da-4aba-a43a-7af9c5893a80",
"timestamp":"2017-04-19T02:31:19.4297387+00:00"
}

{
"code":4018,
"message":"Invalid jobId",
"errorId":"aa400d4b-fffe-ea11-8277-00155d4ff7ed",
"timestamp":"2020-09-25T07:18:22.78Z"
}