Skip to content

Disable, enable or delete member

Switching a member off, on, or deleting them for good

Section titled “Switching a member off, on, or deleting them for good”

Disabling a member blocks their access to your organization, and you can undo it by enabling them again. Permanent deletion can’t be undone, and it only works on a member you’ve already disabled.

All three endpoints need an administrator’s access token. Replace {org_id} with your organization ID and {user_id} with the member’s numeric ID. None of them takes a request body.

  • Authorization: Bearer {your_access_token}
  • Accept: application/json
  • X-Tallyfy-Client: APIClient

DELETE /organizations/{org_id}/users/{user_id}/disable

The member can’t use your organization until you enable them again. Disabling also removes them from all their groups, and deletes any template and process permissions given to them individually.

You can only disable an administrator while another active administrator exists. If you disable the default administrator, that role passes to one of the other administrators.

The one-call remove member endpoint, DELETE /organizations/{org_id}/users/{user_id}, also deactivates a member and can reassign their tasks first. It doesn’t delete their individual template and process permissions.

PUT /organizations/{org_id}/users/{user_id}/enable

This gives a disabled member their access back and puts them back in their groups. It doesn’t restore the template and process permissions that disabling deleted, so grant those again if they need them. Tallyfy also emails the member to say their account is active again.

Enabling can be refused when your organization only allows members to join through single sign-on, or when a trial organization has reached its member limit.

DELETE /organizations/{org_id}/users/{user_id}/delete

The member must be disabled first. Tallyfy adds “(Deleted)” to their last name, changes their email to {email}.deleted.{user_id}, and deletes their account. Their completed work and history stay in your organization. There’s no endpoint to undo this.

const accessToken = 'YOUR_PERSONAL_ACCESS_TOKEN';
const orgId = 'YOUR_ORGANIZATION_ID';
const userId = 12345; // the member's numeric ID
const base = `https://go.tallyfy.com/api/organizations/${orgId}/users/${userId}`;
async function callTallyfy(method, path) {
const response = await fetch(base + path, {
method,
headers: {
'Authorization': `Bearer ${accessToken}`,
'Accept': 'application/json',
'X-Tallyfy-Client': 'APIClient'
}
});
const body = await response.json().catch(() => null);
if (!response.ok) {
throw new Error(`${method} ${path} failed with ${response.status}: ${JSON.stringify(body)}`);
}
return body;
}
async function main() {
// Disable the member. You can undo this.
const disabled = await callTallyfy('DELETE', '/disable');
console.log('Disabled:', disabled.data.email);
// Enable them again:
// await callTallyfy('PUT', '/enable');
// Or permanently delete them. They must be disabled first, and this can't be undone:
// await callTallyfy('DELETE', '/delete');
}
main().catch(error => console.error(error.message));

Each endpoint returns 200 OK with the member’s profile in a data object.

StatusError messageWhat to do
403Forbidden.Use an administrator’s access token.
404Resource not foundCheck that the user ID belongs to a member of this organization.
422Bot users cannot be disabled.Bot users can’t be disabled.
422Bot users cannot be edited.Bot users can’t be enabled either.
422Cannot modify the default administrator. Please assign another member as default administrator first.You’re disabling the only active administrator. Make another member an administrator, then try again.
422Please disable the user before deletion.Call the disable endpoint first, then delete.

Members > Remove member

Tallyfy’s API lets you deactivate a member from your organization using a DELETE request with…