Offboard a team member

Offboard a person with a leaving date and a reason; the profile is archived.

POST https://cotlet.dev/api/v1/charliehr/members/{member_id}/team-member/offboard

write Confirm

Does what "offboard team member" does in the profile settings. Open to Super Admins, Admins and Team Leads. reason is one of the four Charlie lists. The profile is archived, not deleted; the person cannot log in after the leaving date and no longer counts toward future invoices. The person gets no message. Returns the pro-rated allowance. By default you confirm each call; you can switch that off for this tool.

Parameters

Parameters: offboard_team_member
NameTypeDescription
member_id string required string Id from list_team_members
leaving_date string required string YYYY-MM-DD
reason string required string Resignation, Termination, Contract Finished or Other
notes string string Internal notes

Request

cURL
curl -X POST https://cotlet.dev/api/v1/charliehr/members/tm_7d20ab/team-member/offboard \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"leaving_date":"2026-11-30","reason":"Resignation","notes":"Notice given 2 Nov."}'
Python
result = client.call("charliehr", "offboard_team_member", {"member_id":"tm_7d20ab","leaving_date":"2026-11-30","reason":"Resignation","notes":"Notice given 2 Nov."})
Node.js
const result = await cotlet.call('charliehr', 'offboard_team_member', {"member_id":"tm_7d20ab","leaving_date":"2026-11-30","reason":"Resignation","notes":"Notice given 2 Nov."});
CLI
cotlet call charliehr offboard_team_member --data '{"member_id":"tm_7d20ab","leaving_date":"2026-11-30","reason":"Resignation","notes":"Notice given 2 Nov."}'

Example response

JSON

{
  "member_id": "tm_7d20ab",
  "name": "Daniel Kim",
  "status": "archived",
  "leaving_date": "2026-11-30",
  "reason": "Resignation",
  "new_total_allowance": 23,
  "allowance_used": 17,
  "remaining": 6,
  "unit": "days",
  "member_notified": false
}

Sign in once. Your agent does the rest.

Sign up and add the apps you need. Free 7-day trial with 2,000 credits, no card needed.