Skip to main content
PATCH
/
team_members
/
{team_member_id}
Update team member details
curl --request PATCH \
  --url https://{your-subdomain}.neetorecord.com/api/external/v1/team_members/{team_member_id} \
  --header 'Accept: <accept>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "email": "oliver@example.com",
  "first_name": "Oliver",
  "last_name": "Smith",
  "time_zone": "Asia/Kolkata",
  "organization_role": "Admin"
}
'
{
  "team_member": {
    "id": "aaaabbbb-cccc-dddd-eeee-ffff00001111",
    "email": "oliver@example.com",
    "first_name": "Oliver",
    "last_name": "Smith",
    "time_zone": "Asia/Kolkata",
    "profile_image_url": null,
    "active": true,
    "organization_role": "Admin"
  }
}
Deprecated: This is a v1 endpoint. It will continue to work, but we recommend migrating to the v2 equivalent for improved REST compliance (correct HTTP status codes, consistent response envelopes, and hyphenated URLs).
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying subdomain.

Headers

​
X-Api-Key
string
required

API key. Refer to Authentication for more information.

​
Accept
enum<string>
default:application/json
required

Must be application/json.

Available options:
application/json

Path Parameters

​
team_member_id
string<uuid>
required

Id of the team member that you want to update. You can get team_member_id by listing all team members using our List team members API. Here you will see id for each team member.

Example:

"aaaabbbb-cccc-dddd-eeee-ffff00001111"

Body

application/json
​
email
string

Email of the team member.

Example:

"oliver@example.com"

​
first_name
string

First name of the team member.

Example:

"Oliver"

​
last_name
string

Last name of the team member.

Example:

"Smith"

​
time_zone
string

Time zone for the team member. It should be a valid time zone.

Example:

"Asia/Kolkata"

​
organization_role
string

Organization role for the team member. This value should be one of the organization roles of your workspace. The list of organization roles can be seen in Roles page. This value is case sensitive.

Example:

"Admin"

Response

200 - application/json

OK - Request succeeded

​
team_member
object