Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB
Team

BulkCreateTeamMembers

Creates multiple TeamMember objects. The created TeamMember objects are returned on successful creates. This process is non-transactional and processes as much of the request as possible. If one of the creates 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 create.

Learn about Troubleshooting the Team API.

post/v2/team-members/bulk-create

Request body

team_membersobject required

The data used to create the TeamMember objects. Each key is the idempotency_key that maps to the CreateTeamMemberRequest.

Example request

{
  "request_body": {
    "team_members": {
      "idempotency-key-1": {
        "team_member": {
          "assigned_locations": {
            "assignment_type": "EXPLICIT_LOCATIONS",
            "location_ids": [
              "YSGH2WBKG94QZ",
              "GA2Y9HSJ8KRYT"
            ]
          },
          "email_address": "joe_doe@gmail.com",
          "family_name": "Doe",
          "given_name": "Joe",
          "phone_number": "+14159283333",
          "reference_id": "reference_id_1"
        }
      },
      "idempotency-key-2": {
        "team_member": {
          "assigned_locations": {
            "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
          },
          "email_address": "jane_smith@gmail.com",
          "family_name": "Smith",
          "given_name": "Jane",
          "phone_number": "+14159223334",
          "reference_id": "reference_id_2"
        }
      }
    }
  }
}

Response

Success

team_membersobject

The successfully created TeamMember objects. Each key is the idempotency_key that maps to the CreateTeamMemberRequest.

Example response

{
  "team_members": {
    "idempotency-key-1": {
      "team_member": {
        "assigned_locations": {
          "assignment_type": "EXPLICIT_LOCATIONS",
          "location_ids": [
            "GA2Y9HSJ8KRYT",
            "YSGH2WBKG94QZ"
          ]
        },
        "email_address": "joe_doe@gmail.com",
        "family_name": "Doe",
        "given_name": "Joe",
        "id": "ywhG1qfIOoqsHfVRubFV",
        "is_owner": false,
        "phone_number": "+14159283333",
        "reference_id": "reference_id_1",
        "status": "ACTIVE"
      }
    },
    "idempotency-key-2": {
      "team_member": {
        "assigned_locations": {
          "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
        },
        "email_address": "jane_smith@gmail.com",
        "family_name": "Smith",
        "given_name": "Jane",
        "id": "IF_Ncrg7fHhCqxVI9T6R",
        "is_owner": false,
        "phone_number": "+14159223334",
        "reference_id": "reference_id_2",
        "status": "ACTIVE"
      }
    }
  }
}