Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB
Team

BulkUpdateTeamMembers

Updates multiple TeamMember objects. The updated TeamMember objects are returned on successful updates. This process is non-transactional and processes as much of the request as possible. If one of the updates in the request cannot be successfully processed, the request is not marked as failed, but the body of the response contains explicit error information for the failed update. Learn about Troubleshooting the Team API.

post/v2/team-members/bulk-update

Request body

team_membersobject required

The data used to update the TeamMember objects. Each key is the team_member_id that maps to the UpdateTeamMemberRequest.

Example request

{
  "request_body": {
    "team_members": {
      "AFMwA08kR-MIF-3Vs0OE": {
        "team_member": {
          "assigned_locations": {
            "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
          },
          "email_address": "jane_smith@gmail.com",
          "family_name": "Smith",
          "given_name": "Jane",
          "is_owner": false,
          "phone_number": "+14159223334",
          "reference_id": "reference_id_2",
          "status": "ACTIVE"
        }
      },
      "fpgteZNMaf0qOK-a4t6P": {
        "team_member": {
          "assigned_locations": {
            "assignment_type": "EXPLICIT_LOCATIONS",
            "location_ids": [
              "YSGH2WBKG94QZ",
              "GA2Y9HSJ8KRYT"
            ]
          },
          "email_address": "joe_doe@gmail.com",
          "family_name": "Doe",
          "given_name": "Joe",
          "is_owner": false,
          "phone_number": "+14159283333",
          "reference_id": "reference_id_1",
          "status": "ACTIVE"
        }
      }
    }
  }
}

Response

Success

team_membersobject

The successfully updated TeamMember objects. Each key is the team_member_id that maps to the UpdateTeamMemberRequest.

Example response

{
  "team_members": {
    "AFMwA08kR-MIF-3Vs0OE": {
      "team_member": {
        "assigned_locations": {
          "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
        },
        "created_at": "2020-06-11T22:46:57.001Z",
        "email_address": "jane_smith@gmail.com",
        "family_name": "Smith",
        "given_name": "Jane",
        "id": "AFMwA08kR-MIF-3Vs0OE",
        "is_owner": false,
        "phone_number": "+14159223334",
        "reference_id": "reference_id_2",
        "status": "ACTIVE"
      }
    },
    "fpgteZNMaf0qOK-a4t6P": {
      "team_member": {
        "assigned_locations": {
          "assignment_type": "EXPLICIT_LOCATIONS",
          "location_ids": [
            "GA2Y9HSJ8KRYT",
            "YSGH2WBKG94QZ"
          ]
        },
        "created_at": "2020-06-11T22:46:57.095Z",
        "email_address": "joe_doe@gmail.com",
        "family_name": "Doe",
        "given_name": "Joe",
        "id": "fpgteZNMaf0qOK-a4t6P",
        "is_owner": false,
        "phone_number": "+14159283333",
        "reference_id": "reference_id_1",
        "status": "ACTIVE"
      }
    }
  }
}