Update a user

PUT

/api/v1/users/{id}

curl --request PUT \
  --url https://api.pitch2sale.com/api/v1/users/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "first_name": "example", "last_name": "example", "role_id": "example", "is_active": true, "ai_token_limit": 1, "timezone": "example" }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

first_name

string

>= 1 characters <= 100 characters

last_name

string

>= 1 characters <= 100 characters

role_id

string

>= 1 characters

is_active

boolean

ai_token_limit

Any of:

integer

integer

null

null

timezone

string

>= 1 characters <= 64 characters

Example^generated

{
  "first_name": "example",
  "last_name": "example",
  "role_id": "example",
  "is_active": true,
  "ai_token_limit": 1,
  "timezone": "example"
}

Responses

200

OK

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}