Updates a User

put

https://api.edgeiq.io/api/v1/platform/users/{id}

Updates a User

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The ID that specifies a User

Body Params

_id

string

The unique identifier of the user. Assigned at creation, uneditable.

first_name

string

required

The first name of the user.

last_name

string

The last name of the user.

string

required

The email or non-email username of the user. Must be unique.

password

string

required

Used for authentication. Must be at least 8 characters. Required on creation.

password_confirmation

string

Required on creation and only on creation. Must match password.

authentication_token

string

API access token

phone_number

string

The user's phone number.

company_id

string

The id of the company the user belongs to directly.

user_type_id

string

ID of user's type

company_ids

array of strings

A list of company ids which are accounts of the user's company. The user is allowed to view and interact with these companies. Allows management of which sub-accounts users are able to access.

company_ids

metadata

object

This field is a way to store an untyped, key-value, user defined data on a user per user basis

Responses

200

Successful operation

401

You are not authorized

404

The item you were looking for does not exist

500

An unexpected error was encountered.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here!