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.
Servers
- https://connect.squareup.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
team_member_id |
String | Yes |
The ID of the team member to update. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
team_member |
Object | No |
A record representing an individual team member for a business. |
team_member.family_name |
String | No |
The family name (that is, the last name) associated with the team member. |
team_member.id |
String | No |
The unique ID for the team member. |
team_member.given_name |
String | No |
The given name (that is, the first name) associated with the team member. |
team_member.email_address |
String | No |
The email address associated with the team member. |
team_member.assigned_locations |
Object | No |
An object that represents a team member's assignment to locations. |
team_member.assigned_locations.location_ids[] |
Array | No |
The locations that the team member is assigned to. |
team_member.assigned_locations.assignment_type |
String | No |
The current assignment type of the team member. |
team_member.status |
String | No |
Describes the status of the team member. |
team_member.is_owner |
Boolean | No |
Whether the team member is the owner of the Square account. |
team_member.created_at |
String | No |
The timestamp, in RFC 3339 format, describing when the team member was created. For example, "2018-10-04T04:00:00-07:00" or "2019-02-05T12:00:00Z". |
team_member.phone_number |
String | No |
The team member's phone number, in E.164 format. For example: +14155552671 - the country code is 1 for US +551155256325 - the country code is 55 for BR |
team_member.reference_id |
String | No |
A second ID used to associate the team member with an entity in another system. |
team_member.updated_at |
String | No |
The timestamp, in RFC 3339 format, describing when the team member was last updated. For example, "2018-10-04T04:00:00-07:00" or "2019-02-05T12:00:00Z". |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.