PATCH/api/partner/users/:userId

Fill in missing fields

Fills in the fields one of your users has not set yet. A field that already has a value is never overwritten, and an address is added only when the user has none. Returns a fresh session and the status the user had before this call.

Path parameters

Field Type Required
userId string yes

Request body

Field Type Required
firstName string or null no
lastName string or null no
displayName string or null no
legalName string or null no
entityType string or null no
website string or null no
defaultRole string or null no
businessDescription string or null no
averageTransactionSize number or null no
averageWeeklyTransactions number or null no
address <Address> or null no
street string yes
streetLine2 string or null no
city string yes
state string yes
postalCode string yes
country string yes

What each field means

Field Type Meaning
displayName string the business name
legalName string the business's legal name
entityType string one of sole_proprietorship, limited_liability_partnership, limited_liability_company, c_corporation, s_corporation or b_corporation

An update fills only empty fields; email and phone are never changed.

200 OK
{
  "success": true,
  "message": "User updated",
  "result": {
    "userId": "8f2c1d4e-6b7a-4c3d-9e1f-2a3b4c5d6e7f",
    "jwt": "eyJhbGciOi…",
    "refreshJwt": "eyJhbGciOi…",
    "status": "review",
    "referralToken": "maya-ortiz"
  }
}