PATCH
/
team_members
/
{team_member_id}
Update team member details
curl --request PATCH \
  --url https://{your-workspace}.neetocal.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",
  "active": false
}'
{
  "team_member": {
    "id": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "time_zone": "<string>",
    "profile_image_url": "<string>",
    "active": true,
    "organization_role": "<string>"
  }
}
Replace {your-workspace} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

​
X-Api-Key
string
required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

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

Specifies the expected response format. Must be set to application/json for proper API communication.

Available options:
application/json

Path Parameters

​
team_member_id
string
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 all team members API. Here you will see id for each team member.

Example:

"13c02be6-8bd4-4dda-b9e6-07df53feb8a4"

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"

​
active
boolean

Whether the team member is active or not.

Example:

false

Response

200 - application/json

OK - Request succeeded

​
team_member
object