Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB
Team

CreateTeamMember

Creates a single TeamMember object. The TeamMember object is returned on successful creates. You must provide the following values in your request to this endpoint:

  • given_name
  • family_name

Learn about Troubleshooting the Team API.

post/v2/team-members

Request body

idempotency_keystring

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.

Example request

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

Response

Success

Example response

{
  "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": "1yJlHapkseYnNPETIU1B",
    "is_owner": false,
    "phone_number": "+14159283333",
    "reference_id": "reference_id_1",
    "status": "ACTIVE"
  }
}