Create user group

Request

This endpoint is used to create user groups.

Security

Bearer

Path

companyIdstring, (uuid)required

Company ID of the user group.

Example:1234a66b-7493-4f41-908c-58ba81093653

Bodyapplication/jsonrequired

namestringrequired

Name of the user group.

Example:"Company Admins"

descriptionstringrequired

A description of the user group.

Example:"Group for managing the company settings."

curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v3/companies/1234a66b-7493-4f41-908c-58ba81093653/user-groups \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Company Admins",
    "description": "Group for managing the company settings."
  }'

Responses

OK

Bodyapplication/json

idstring, (uuid)required

Example:"b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"

Response

{
  "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
}