Update person

PUT 
/api/v2/People/:key

Update person

Request

Path Parameters

key stringrequired

Guid or ExternalKey

application/json

Body

required

FirstName stringnullable

Possible values: <= 25 characters

LastName stringrequired

Possible values: non-empty and <= 25 characters

NameSuffix stringnullable

Possible values: <= 25 characters

Code stringnullable

Possible values: <= 100 characters

Email stringrequired

Possible values: non-empty and <= 65 characters, Value must match regular expression ^[-+'_!a-zA-Z0-9]([.]?[-+'_!a-zA-Z0-9])*@([a-zA-Z0-9][-a-zA-Z0-9]*[.])+[a-zA-Z]{2,63}$

PhoneNumber stringnullable

Possible values: <= 30 characters

Note stringnullable

Possible values: <= 500 characters

Inactive booleannullable
Default value: false
ClosedPeriodTo date-timenullable
LegislationCountry stringnullable
Possible values: <= 3 characters
Default value: Set from account country
Language stringnullable
Possible values: Value must match regular expression ^(en-US|cs-CZ|sk-SK|pl-PL)
Default value: en-US
ExternalKey stringnullable

Possible values: <= 100 characters

Branch guidnullable

Responses

200

Successfully Updated

application/json

Schema

Schema

Guid guidnullable

Example (from schema)

{
  "Guid": "string"
}

400

Error

application/json

Schema

Schema

Error

object

required

Code stringnullable

Message stringnullable

Example (from schema)

{
  "Error": {
    "Code": "string",
    "Message": "string"
  }
}

404

Not Found

Loading...