Save Details

PATCH

/api/onboard/details

curl --request PATCH \
  --url https://example.com/api/onboard/details \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "invitationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "firstName": "example", "lastName": "example", "phone": "example", "addressLine1": "example", "city": "example", "state": "example", "postCode": "example", "country": "example" }'

Saves the personal-details step. Safe to call more than once. The wizard re-sends this on every Continue.

Authorizations

• Bearer

Request Body

object

invitationId

string format: uuid

firstName

required

string

>= 1 characters <= 100 characters

lastName

required

string

>= 1 characters <= 100 characters

phone

string

nullable <= 50 characters

addressLine1

string

nullable <= 200 characters

city

string

nullable <= 100 characters

state

string

nullable <= 50 characters

postCode

string

nullable <= 20 characters

country

string

nullable <= 2 characters

Example ^generated

{
  "invitationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "firstName": "example",
  "lastName": "example",
  "phone": "example",
  "addressLine1": "example",
  "city": "example",
  "state": "example",
  "postCode": "example",
  "country": "example"
}

object

invitationId

string format: uuid

firstName

required

string

>= 1 characters <= 100 characters

lastName

required

string

>= 1 characters <= 100 characters

phone

string

nullable <= 50 characters

addressLine1

string

nullable <= 200 characters

city

string

nullable <= 100 characters

state

string

nullable <= 50 characters

postCode

string

nullable <= 20 characters

country

string

nullable <= 2 characters

Example ^generated

{
  "invitationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "firstName": "example",
  "lastName": "example",
  "phone": "example",
  "addressLine1": "example",
  "city": "example",
  "state": "example",
  "postCode": "example",
  "country": "example"
}

object

invitationId

string format: uuid

firstName

required

string

>= 1 characters <= 100 characters

lastName

required

string

>= 1 characters <= 100 characters

phone

string

nullable <= 50 characters

addressLine1

string

nullable <= 200 characters

city

string

nullable <= 100 characters

state

string

nullable <= 50 characters

postCode

string

nullable <= 20 characters

country

string

nullable <= 2 characters

Example ^generated

{
  "invitationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "firstName": "example",
  "lastName": "example",
  "phone": "example",
  "addressLine1": "example",
  "city": "example",
  "state": "example",
  "postCode": "example",
  "country": "example"
}

Responses

204

No Content

400

Bad Request

Media type application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

409

Conflict

Media type application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}