Update a person

Updates a person's name, email, type or start date. Changing the email stops their current link working.

Authorization

ApiKeyAuth

x-api-key<token>

In: header

Path Parameters

organizationId*string

personId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length <= 256

email?string

Match^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Formatemail

Lengthlength <= 320

employmentType?string

Value in

"employee"
"contractor"

startDate?|null

groupIds?array<>

Itemsitems <= 100

Response Body

`application/json`

curl -X PATCH "https://example.com/organizations/string/people/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "organizationId": "string",  "name": "string",  "email": "string",  "employmentType": "employee",  "status": "active",  "startDate": "string",  "endDate": "string",  "offboardedAt": null,  "offboarding": {    "accessRemovedOn": "string",    "evidenceUrl": "string",    "notRequiredReason": "string",    "recordedByUserId": "string",    "recordedAt": null  },  "lastEmailedAt": null,  "lastEmailFailedAt": null,  "lastEmailFailure": "not_allowed",  "policyCounts": {    "owed": -9007199254740991,    "acknowledged": -9007199254740991,    "overdue": -9007199254740991  },  "groupIds": [    "string"  ],  "dateCreated": null,  "dateUpdated": null}

Update a person

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

422application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`