People V2

Update people

Updates a person's information in an organization. Requires admin permissions.

post/v2/people/{organizationId}/{peopleId}

Request

  • Base URL: https://api.zephyr-cloud.io
  • URL: https://api.zephyr-cloud.io/v2/people/{organizationId}/{peopleId}
  • Auth: HTTP bearer

Path parameters

organizationIdstring uuid required

Organization ID

Example:550e8400-e29b-41d4-a716-446655440000
peopleIdstring uuid required

People (User) ID

Example:550e8400-e29b-41d4-a716-446655440001

Request body

namestring required

Updated name

emailstring email required

Updated email address

role'viewer' | 'editor' | 'admin' | 'owner' required

Updated role

Example request

{
  "name": "John Doe Jr.",
  "email": "john.updated@example.com",
  "role": "admin"
}

Response

Person updated successfully

Example response

{
  "value": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "John Doe",
    "email": "john@example.com",
    "role": "editor"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.