Skip to main content
POST
Add a user to 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 added to the organisation, or already belonged to it

message
string
Example:

"User 'jane@example.com' added to organisation with ID 12"

errors
string

Present instead of message when the user is already a member of the organisation

Example:

"User 'jane@example.com' already belongs to organisation with ID 12"