Deactivate a User

post/public/v1/users/{user}/deactivate

Signs the user out everywhere and stops them signing in. They are removed as primary and service coordinator and unassigned from their future shifts, and the user.deactivated webhook is sent. employment_end_date defaults to today in the provider's timezone.

Refuses with a 409 when the user is already deactivated, or still holds public API keys, and with a 403 for the account owner.

post/public/v1/users/{user}/deactivate

curl --request POST \
  --url 'https://api.app.astalty.com.au/public/v1/users/{user}/deactivate' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "employment_end_date": "2026-07-01",
  "exit_details": "string"
}'

Response

{
  "data": {
    "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "status": "active",
    "employment_title": "Service Manager"
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

userstringrequired
The user UUID

Body

application/json

employment_end_datestring<date> | null
exit_detailsstring | nullmax length 65535
Limited to 65535 bytes.

Response

200application/json

UserResource

dataobjectrequired
▶Show 6 child attributesHide child attributes
- idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- first_namestringrequired
  Example:John
- last_namestringrequired
  Example:Doe
- emailstringrequired
  Example:john.doe@example.com
- statusenum<string>required
  Available options:activedeactivatedinvitedrestricted
- employment_titlestring | nullrequired
  Example:Service Manager

Errors

401Unauthenticated
403Authorization error
404Not found
409An error
422Validation error