oont-contents/plugins/woocommerce-square/vendor/square/square/doc/models/create-team-member-response.md
2025-02-08 15:10:23 +01:00

1.7 KiB

Create Team Member Response

Represents a response from a create request containing the created TeamMember object or error messages.

Structure

CreateTeamMemberResponse

Fields

Name Type Tags Description Getter Setter
teamMember ?TeamMember Optional A record representing an individual team member for a business. getTeamMember(): ?TeamMember setTeamMember(?TeamMember teamMember): void
errors ?(Error[]) Optional The errors that occurred during the request. getErrors(): ?array setErrors(?array errors): void

Example (as JSON)

{
  "team_member": {
    "assigned_locations": {
      "assignment_type": "EXPLICIT_LOCATIONS",
      "location_ids": [
        "GA2Y9HSJ8KRYT",
        "YSGH2WBKG94QZ"
      ]
    },
    "created_at": "2021-06-11T22:55:45Z",
    "email_address": "joe_doe@example.com",
    "family_name": "Doe",
    "given_name": "Joe",
    "id": "1yJlHapkseYnNPETIU1B",
    "is_owner": false,
    "phone_number": "+14159283333",
    "reference_id": "reference_id_1",
    "status": "ACTIVE",
    "updated_at": "2021-06-11T22:55:45Z"
  },
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "MAP_KEY_LENGTH_TOO_LONG",
      "detail": "detail6",
      "field": "field4"
    },
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "MAP_KEY_LENGTH_TOO_LONG",
      "detail": "detail6",
      "field": "field4"
    },
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "MAP_KEY_LENGTH_TOO_LONG",
      "detail": "detail6",
      "field": "field4"
    }
  ]
}