Add user to organization

Associates an existing user with an organization, assigning them a custom role and access level (default/admin/super-admin).

PUT/api/v1/{team_slug}/{app_slug}/organisations/{org_id}/user

management-api:PUT:/api/v1/{team_slug}/{app_slug}/organisations/{org_id}/user

Associates an existing user with an organization, assigning them a custom role and access level (default/admin/super-admin).

API ownership

API family: Management API
Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
Do not use from: Browser-only storefront code or public clients.
Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Method: PUT
Path: /api/v1/\{team_slug\}/\{app_slug\}/organisations/\{org_id\}/user
Summary: Add user to organization
Description: Associates an existing user with an organization, assigning them a custom role and access level (default/admin/super-admin).
OpenAPI contract: management-api
Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters3 parameters

Name	In	Required	Type	Description
app_slug	path	Yes	string	App slug
team_slug	path	Yes	string	Team slug
org_id	path	Yes	string	Organization ID

Request bodyDocumented body

Property	Type	Required	Details
`custom_role_id`	string	Yes	-
`level`	enum("default", "admin", "super-admin")	Yes	-
`user_id`	string	Yes	-

Generated example (synthetic):

{
  "custom_role_id": "string",
  "level": "default",
  "user_id": "string"
}

Responses5 statuses

Status	Description	Content
200	User added to organization successfully	application/json (object)
400	Invalid request (e.g. bad payload, validation error)	application/json (object)
401	Unauthorized access	application/json (object)
404	Organization or user or custom role not found	application/json (object)
500	Internal server error	application/json (object)

Property	Type	Required	Details
`data`	string	No	-
`details`	string[]	No	Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
`success`	boolean	No	-

Generated example (synthetic):

{
  "data": "string",
  "details": [
    "string"
  ],
  "success": false
}

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Use these fields to confirm you are implementing the intended endpoint contract.