Update user in current organization

PUT

/api/accounts/users/{id}

curl --request PUT \
  --url https://api.getvespy.com/api/accounts/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com", "fullName": "example", "isActive": true, "password": "example", "phone": "example", "role": "admin" }'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

Any of:

object

object

email

required

string format: email

fullName

string

>= 1 characters <= 160 characters

isActive

boolean

password

string

>= 8 characters

phone

string

nullable <= 32 characters

role

string

Allowed values: admin manager staff tenant owner vendor

object

object

email

string format: email

fullName

required

string

>= 1 characters <= 160 characters

isActive

boolean

password

string

>= 8 characters

phone

string

nullable <= 32 characters

role

string

Allowed values: admin manager staff tenant owner vendor

object

object

email

string format: email

fullName

string

>= 1 characters <= 160 characters

isActive

boolean

password

string

>= 8 characters

phone

string

nullable <= 32 characters

role

required

string

Allowed values: admin manager staff tenant owner vendor

object

object

email

string format: email

fullName

string

>= 1 characters <= 160 characters

isActive

boolean

password

required

string

>= 8 characters

phone

string

nullable <= 32 characters

role

string

Allowed values: admin manager staff tenant owner vendor

object

object

email

string format: email

fullName

string

>= 1 characters <= 160 characters

isActive

required

boolean

password

string

>= 8 characters

phone

string

nullable <= 32 characters

role

string

Allowed values: admin manager staff tenant owner vendor

object

object

email

string format: email

fullName

string

>= 1 characters <= 160 characters

isActive

boolean

password

string

>= 8 characters

phone

required

string

nullable <= 32 characters

role

string

Allowed values: admin manager staff tenant owner vendor

Responses

200

Default Response

Media typeapplication/json

object

user

required

object

deletedAt

required

string format: date-time

nullable

email

required

string format: email

emailConsentAt

required

string format: date-time

nullable

fullName

required

string

id

required

string format: uuid

isActive

required

boolean

isSuperadmin

required

boolean

organizationId

required

string format: uuid

phone

required

string

nullable

role

required

string

Allowed values: admin manager staff tenant owner vendor

smsConsentAt

required

string format: date-time

nullable

Example

{
  "user": {
    "role": "admin"
  }
}

400

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

404

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

409

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}