bulk-create-team-members-request.md

Bulk Create Team Members Request

Represents a bulk create request for TeamMember objects.

Structure

BulkCreateTeamMembersRequest

Fields

Name	Type	Tags	Description
teamMembers	Record<string, CreateTeamMemberRequest>	Required	The data used to create the TeamMember objects. Each key is the idempotency_key that maps to the CreateTeamMemberRequest. The maximum number of create objects is 25.

Example (as JSON)

{
  "team_members": {
    "idempotency-key-1": {
      "team_member": {
        "assigned_locations": {
          "assignment_type": "EXPLICIT_LOCATIONS",
          "location_ids": [
            "YSGH2WBKG94QZ",
            "GA2Y9HSJ8KRYT"
          ]
        },
        "email_address": "[email protected]",
        "family_name": "Doe",
        "given_name": "Joe",
        "phone_number": "+14159283333",
        "reference_id": "reference_id_1",
        "id": "id6",
        "is_owner": false,
        "status": "ACTIVE"
      },
      "idempotency_key": "idempotency_key4"
    },
    "idempotency-key-2": {
      "team_member": {
        "assigned_locations": {
          "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
        },
        "email_address": "[email protected]",
        "family_name": "Smith",
        "given_name": "Jane",
        "phone_number": "+14159223334",
        "reference_id": "reference_id_2",
        "id": "id6",
        "is_owner": false,
        "status": "ACTIVE"
      },
      "idempotency_key": "idempotency_key4"
    }
  }
}