Skip to content

Latest commit

 

History

History
82 lines (73 loc) · 2.19 KB

update-team-member-response.md

File metadata and controls

82 lines (73 loc) · 2.19 KB

Update Team Member Response

Represents a response from an update request containing the updated TeamMember object or error messages.

Structure

UpdateTeamMemberResponse

Fields

Name Type Tags Description Getter
TeamMember TeamMember Optional A record representing an individual team member for a business. TeamMember getTeamMember()
Errors List<Error> Optional The errors that occurred during the request. List getErrors()

Example (as JSON)

{
  "team_member": {
    "assigned_locations": {
      "assignment_type": "EXPLICIT_LOCATIONS",
      "location_ids": [
        "GA2Y9HSJ8KRYT",
        "YSGH2WBKG94QZ"
      ]
    },
    "created_at": "2021-06-11T22:55:45Z",
    "email_address": "[email protected]",
    "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-15T17:38:05Z",
    "wage_setting": {
      "created_at": "2021-06-11T22:55:45Z",
      "is_overtime_exempt": true,
      "job_assignments": [
        {
          "annual_rate": {
            "amount": 3000000,
            "currency": "USD"
          },
          "hourly_rate": {
            "amount": 1443,
            "currency": "USD"
          },
          "job_id": "FjS8x95cqHiMenw4f1NAUH4P",
          "job_title": "Manager",
          "pay_type": "SALARY",
          "weekly_hours": 40
        },
        {
          "hourly_rate": {
            "amount": 1200,
            "currency": "USD"
          },
          "job_id": "VDNpRv8da51NU8qZFC5zDWpF",
          "job_title": "Cashier",
          "pay_type": "HOURLY"
        }
      ],
      "team_member_id": "1yJlHapkseYnNPETIU1B",
      "updated_at": "2021-06-11T22:55:45Z",
      "version": 1
    }
  },
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "INVALID_EXPIRATION",
      "detail": "detail6",
      "field": "field4"
    }
  ]
}