Skip to main content
Add known users to an organisation and remove them. To get an organisation’s ID, list organisations. Before you start, read the API overview for how authentication, headers, pagination and errors work.

​
Add a user to an organisation

Add a known user to an organisation.
​
string
required
The ID of the organisation to add the user to.
​
string
required
The email address of the user to add.
​
boolean
default:false
Whether the user owns the organisation. Owners can manage the organisation and add or remove other users.
Add a user to an organisation
POST https://your-community.zapnito.com/api/v1/organisations/:organisation_id/users
  • 200 OK: the user was added, or already belongs to the organisation. If they already belong, the response carries an errors message instead: User 'alex.smith@example.com' already belongs to organisation with ID 123.
  • 401 Unauthorized: your API token is invalid, expired or badly formatted. See authentication.
  • 404 Not Found: no organisation matches the ID, or no user matches the email address. The messages read Organisation not found for ID: 123 and User not found for email: '...'.

​
Remove a user from an organisation

Remove a known user from an organisation.
​
string
required
The ID of the organisation to remove the user from.
​
string
required
The email address of the user to remove.
Remove a user from an organisation
DELETE https://your-community.zapnito.com/api/v1/organisations/:organisation_id/users
  • 200 OK: the user was removed, or wasn’t in the organisation. If they weren’t in the organisation, the response carries an errors message instead: User 'jordan.lee@example.com' does not currently belong to organisation with ID 123.
  • 401 Unauthorized: your API token is incorrect or expired. See authentication.
  • 404 Not Found: no organisation matches the ID, or no user matches the email address. The messages read Organisation not found for ID: 123 and User not found for email: '...'.