Bulk Create Team Members - Automate.ax

square.bulkCreateTeamMembers creates multiple TeamMember objects.

Example

automations/square-bulk-create-team-members.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Bulk Square Create Team Members", () => {
  onDashboardRun({ title: "Bulk Square Create Team Members" })

  square.bulkCreateTeamMembers({
    teamMembers: {
      "idempotency-key-1": {
        teamMember: {
          referenceId: "reference_id_1",
          givenName: "Joe",
          familyName: "Doe",
          emailAddress: "joe_doe@gmail.com",
          phoneNumber: "+14159283333",
          assignedLocations: {
            assignmentType: "EXPLICIT_LOCATIONS",
            locationIds: ["YSGH2WBKG94QZ", "GA2Y9HSJ8KRYT"],
          },
        },
      },
      "idempotency-key-2": {
        teamMember: {
          referenceId: "reference_id_2",
          givenName: "Jane",
          familyName: "Smith",
          emailAddress: "jane_smith@gmail.com",
          phoneNumber: "+14159223334",
          assignedLocations: {
            assignmentType: "ALL_CURRENT_AND_FUTURE_LOCATIONS",
          },
        },
      },
    },
  })
})

Inputs

Every input accepts a compatible signal. It requires EMPLOYEES_WRITE.

Field	Type	Required	Default	Description
`teamMembers`	`Record\<string, Square.CreateTeamMemberRequest\>`	Yes	—	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.

Use the official BulkCreateTeamMembers reference for provider field semantics and limits.

Output

Returns the official Square.BatchCreateTeamMembersResponse response as a codec-safe object. Square integer money amounts remain bigint values.