Add member

Add a member to an organization.

POST /api/organizations/{organizationId}/members/add

Try it

Add member

cURL

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/members/add \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "usernameOrEmail": "<string>",
  "role": "admin",
  "datasets": [
    "<string>"
  ]
}
'

200

{
  "success": true,
  "id": 123,
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

Path Parameters

organizationId · integer · required

Organization ID

Body

application/json

usernameOrEmail · string · required

Username or e-mail address

role · enum<string> · required

Available options: admin, member, guest

datasets · string[] · required

Only used for 'guest' users. Limits the datasets the user has access to.

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

id · integer · required

Unique identifier of the created entity.

error · string

Optional error description (set if 'success' was false)