Bulk create team members

POST

/v2/team-members/bulk-create

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.

Permissions:EMPLOYEES_WRITE

Guide

Bulk create team members

Try in API Explorer

Link to section

Request body

Example code

Link to section

team_members

Map<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.

If you include a team member's wage_setting, you must provide job_id for each job assignment. To get job IDs, call ListJobs.

Show attributes

Link to section

Response fields

Link to section

team_members

Map<string, CreateTeamMemberResponse>

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

Show attributes

Link to section

errors

Error[ ]

The errors that occurred during the request.

Show attributes

Link to section

Examples

API version2026-08-19

All versions ->

POST/v2/team-members/bulk-create

cURL

curl https://connect.squareup.com/v2/team-members/bulk-create \
  -X POST \
  -H 'Square-Version: 2026-08-19' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "team_members": {
      "idempotency-key-1": {
        "team_member": {
          "given_name": "Joe",
          "family_name": "Doe",
          "email_address": "[email protected]",
          "reference_id": "reference_id_1",
          "phone_number": "+14159283333",
          "assigned_locations": {
            "location_ids": [
              "YSGH2WBKG94QZ",
              "GA2Y9HSJ8KRYT"
            ],
            "assignment_type": "EXPLICIT_LOCATIONS"
          }
        }
      },
      "idempotency-key-2": {
        "team_member": {
          "given_name": "Jane",
          "family_name": "Smith",
          "email_address": "[email protected]",
          "reference_id": "reference_id_2",
          "phone_number": "+14159223334",
          "assigned_locations": {
            "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
          }
        }
      }
    }
  }'

Response JSON

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