PUT /v2/team-members/{team_member_id}

Update team member

PUT

/v2/team-members/{team_member_id}

Updates a single TeamMember object.

The TeamMember object is returned on successful updates. Learn about Troubleshooting the Team API.

Permissions:EMPLOYEES_WRITE

Guide

Update a team member

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

team_member_id

string

Required

The ID of the team member to update.

Link to section

Request body

Link to section

team_member

The data used to update the TeamMember object.

Link to section

Response fields

Link to section

team_member

The successfully updated TeamMember object.

Link to section

errors

The errors that occurred during the request.

curl https://connect.squareup.com/v2/team-members/1yJlHapkseYnNPETIU1B \ -X PUT \ -H 'Square-Version: 2024-10-17' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ -H 'Content-Type: application/json' \ -d '{ "team_member": { "reference_id": "reference_id_1", "status": "ACTIVE", "given_name": "Joe", "family_name": "Doe", "email_address": "[email protected]", "phone_number": "+14159283333", "assigned_locations": { "location_ids": [ "YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT" ], "assignment_type": "EXPLICIT_LOCATIONS" } } }'

{ "team_member": { "id": "1yJlHapkseYnNPETIU1B", "reference_id": "reference_id_1", "is_owner": false, "status": "ACTIVE", "given_name": "Joe", "family_name": "Doe", "email_address": "[email protected]", "phone_number": "+14159283333", "created_at": "2021-06-11T22:55:45Z", "updated_at": "2021-06-15T17:38:05Z", "assigned_locations": { "assignment_type": "EXPLICIT_LOCATIONS", "location_ids": [ "GA2Y9HSJ8KRYT", "YSGH2WBKG94QZ" ] } } }

Update team member

Path parameters

Request body

Response fields

Error descriptions