Skip to content

Create a help desk team member

Workforce module

POST/help-desk-team-membershelpDeskTeamMembers.create

A member who answers a help desk team's requests. Deleting removes them. Creates a help desk team member. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability org.help.write.
  • OAuth scopes: org.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: HelpDeskTeamMemberCreate

helpDeskTeamMembers.create: HelpDeskTeamMemberCreate
FieldTypeRequiredDescription
help_desk_team_idstring (uuid)YesIdentifier of the team.
membership_idstring (uuid)YesIdentifier of the member.
{
  "help_desk_team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Response 201: HelpDeskTeamMember

helpDeskTeamMembers.create: HelpDeskTeamMember
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the help desk team member.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesPerson who last updated the row; null for seed, platform or system writes.
help_desk_team_idstring (uuid)YesIdentifier of the team.
membership_idstring (uuid)YesIdentifier of the member.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "help_desk_team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X POST "$XOS_BASE_URL/help-desk-team-members" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"help_desk_team_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data } = await xos.helpDeskTeamMembers.create({
    "help_desk_team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });
response = xos.help_desk_team_members.create({"help_desk_team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})
xos help-desk-team-members create --data '{"help_desk_team_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'