Update a person

PUT

/api/v1/person/{person_id}

const url = 'https://app.prefactorai.com/api/v1/person/013xrzp12g3nqk8ns6jadrqmpgrjkeny';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"email":"jane@example.com","name":"Jane Doe","team_ids":["013xrzp12g3nqk8ns6jadrqmpgrjkeny"],"title":"Engineer"}'
};

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/person/013xrzp12g3nqk8ns6jadrqmpgrjkeny \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "jane@example.com", "name": "Jane Doe", "team_ids": [ "013xrzp12g3nqk8ns6jadrqmpgrjkeny" ], "title": "Engineer" }'

Authorizations

authorization

Parameters

Path Parameters

person_id

required

Person_Id

A valid person ID

string

Example

013xrzp12g3nqk8ns6jadrqmpgrjkeny

Request Body

Person_ForUpdate

Parameters for updating a person

object

email

Person email address (omit to keep current)

string

Example

jane@example.com

name

Person name (omit to keep current)

string

Example

Jane Doe

team_ids

Team IDs to assign (omit to keep current; empty array to clear)

Array<string>

title

One of:

string
Null

string

Example

Engineer

Responses

200

Success

application/json

object

details

Person_Details

object

email

Person email address

string

Person_Id

A valid person ID

string

inserted_at

When the person was created

string format: date-time

name

Person name

string

team_ids

Team IDs this person belongs to

Array<string>

title

One of:

string
Null

Optional job title

string

type

Type of resource (always ‘person’)

string

Allowed values: person

updated_at

When the person was last updated

string format: date-time

status

string

Allowed values: success

Example

{
  "details": {
    "email": "jane@example.com",
    "id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "name": "Jane Doe",
    "team_ids": [
      "013xrzp12g3nqk8ns6jadrqmpgrjkeny"
    ],
    "title": "Engineer",
    "type": "person"
  },
  "status": "success"
}

default

Error

application/json

One of:

object
object

object

code

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

message

string

status

string

Allowed values: error

Example

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