Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 1.15 KB

create-team-member-request.md

File metadata and controls

39 lines (30 loc) · 1.15 KB

Create Team Member Request

Represents a create request for a TeamMember object.

Structure

CreateTeamMemberRequest

Fields

Name Type Tags Description
idempotencyKey string | undefined Optional A unique string that identifies this CreateTeamMember request.
Keys can be any valid string, but must be unique for every request.
For more information, see Idempotency.

The minimum length is 1 and the maximum length is 45.
teamMember TeamMember | undefined Optional A record representing an individual team member for a business.

Example (as JSON)

{
  "idempotency_key": "idempotency-key-0",
  "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",
    "status": "ACTIVE"
  }
}