Skip to main content
DELETE
Remove a user from an organisation

Authorizations

Authorization
string
header
default:Token token=<api-key>
required

API authentication using your community API secret. The value below is sent as the Authorization header verbatim, so paste the whole header value including the prefix: Token token=

Path Parameters

organisation_id
integer
required

The ID of the organisation

Body

application/json

Payload wrapped in a user object

user
object
required

Response

The user was removed from the organisation, or did not belong to it

message
string
Example:

"User 'jane@example.com' removed from organisation with ID 12"

errors
string

Present instead of message when the user does not belong to the organisation

Example:

"User 'jane@example.com' does not currently belong to organisation with ID 12"