Update a user

PATCH 
/v3/users/:id

Update a user

Request

Path Parameters

id numberrequired

application/json

Body

name string

Possible values: <= 255 characters

Name of the user

role_id number

User role Id

Responses

200

Successful

*/*

Schema

Schema

data

object

id number

User Id

name string

User name

email string

User email

phone string

User phone number

admin boolean

Is user an admin

owner boolean

Is user owner of the account

agency_owner boolean

Is user an agency owner

verified boolean

Is user account verified?

role_id number

Id of the user role

Example (from schema)

{
  "data": {
    "id": 1,
    "name": "Jane Doe",
    "email": "johndoe@example.com",
    "phone": "+1384843",
    "admin": false,
    "owner": true,
    "agency_owner": false,
    "verified": true,
    "role_id": 2
  }
}

Loading...