Update an admin user (own profile only)

PUT

/api/v1/admin_user/{admin_user_id}

const url = 'https://app.prefactorai.com/api/v1/admin_user/013xrzp12g3nqk8ns6jadrqmpgrjkeny';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"job_title":null,"name":"example","profile_completed_at":"2024-01-01T00:00:00Z"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://app.prefactorai.com/api/v1/admin_user/013xrzp12g3nqk8ns6jadrqmpgrjkeny \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "job_title": null, "name": "example", "profile_completed_at": "2024-01-01T00:00:00Z" }'

Authorizations

authorization

Parameters

Path Parameters

admin_user_id

required

AdminUser_Id

A valid admin user ID

string

Example

013xrzp12g3nqk8ns6jadrqmpgrjkeny

Request Body

AdminUser_DetailsForUpdate

object

job_title

One of:

string
Null

Job title within the account

string

name

Admin user name

string

profile_completed_at

One of:

string
Null

When the user completed their profile (set on profile completion)

string format: date-time

Example

2024-01-01T00:00:00Z

Responses

200

Success

application/json

object

details

required

AdminUser_Details

object

account_id

required

Account_Id

A valid account ID

string

email

required

Admin user email

string

required

AdminUser_Id

A valid admin user ID

string

inserted_at

required

When the admin user was created

string format: date-time

job_title

required

One of:

string
Null

Job title within the account

string

last_active_at

required

One of:

string
Null

When the admin user was last active; nil means no recorded activity

string format: date-time

name

required

One of:

string
Null

Admin user name

string

profile_completed_at

required

One of:

string
Null

When the user completed their profile (set on profile completion)

string format: date-time

switchable_account_summaries

required

Accounts this admin user can switch to

Array<object>

Account_Summary

object

required

Account_Id

A valid account ID

string

name

required

Account name

string

type

required

Type of resource (always ‘account’)

string

Allowed values: account

type

required

Type of resource (always ‘admin_user’)

string

Allowed values: admin_user

updated_at

required

When the admin user was last updated

string format: date-time

status

required

string

Allowed values: success

Example

{
  "details": {
    "account_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "email": "john@example.com",
    "id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "inserted_at": "2024-01-01T00:00:00Z",
    "job_title": "Developer",
    "last_active_at": "2024-01-01T00:00:00Z",
    "name": "John Doe",
    "profile_completed_at": "2024-01-01T00:00:00Z",
    "switchable_account_summaries": [
      {
        "id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
        "name": "My Account",
        "type": "account"
      }
    ],
    "type": "admin_user",
    "updated_at": "2024-01-01T00:00:00Z"
  },
  "status": "success"
}

default

Error

application/json

One of:

object

code

required

string

Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action alert_unknown alert_already_cleared invalid_value required_value idempotency_key_already_used temporarily_unavailable conflict

message

required

string

status

required

string

Allowed values: error

Example

{
  "code": "bad_request",
  "status": "error"
}