Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY

Examples

// Successful request
POST /api/v2/collections/4SWY1hUqC9dMptxNs66l/user_groups/2
200
{
  "ok": "User group 2 was added succesfully"
}
// User group is already added
POST /api/v2/collections/eUlaxtOinioj-WTsl9DZ/user_groups/3
400
{
  "error": "User group with id 3 is already part of this Collection"
}
// If :collection_id is not found
POST /api/v2/collections/not-found-id/user_groups/4
404
{
  "error": "collection not found"
}
// If :user_group_id is not found
POST /api/v2/collections/F_XY4mBq4xq5b6nT5z-e/user_groups/not-found-id
404
{
  "error": "Couldn't find UserGroup with 'id'=not-found-id"
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters