Skip to main content
POST
/
users
/
{user}
/
units
Add unit membership
curl --request POST \
  --url https://api.example.com/users/{user}/units \
  --header 'Content-Type: application/json' \
  --data '
{
  "unit": 123,
  "userTypes": [
    123
  ]
}
'
{
  "id": 1,
  "abilities": {},
  "unit": {
    "content_type": "unit",
    "id": 1,
    "reference": "<string>",
    "name": "HQ",
    "description": "<string>",
    "level": 123,
    "path": "<string>",
    "unit_type": "unit",
    "falldown": true,
    "features": [
      {}
    ],
    "departments": [
      {}
    ],
    "parent": {},
    "image": {},
    "children": [
      {}
    ],
    "addresses": {},
    "contact": {},
    "opening_hours": {},
    "geo": {
      "lat": 123,
      "lng": 123
    },
    "stats": {
      "users": 123,
      "children": 123,
      "children_total": 123
    },
    "permissions": {},
    "url": "api/units/1"
  },
  "department": {},
  "userTypes": [
    {}
  ],
  "permissions": {
    "edit": true,
    "delete": true
  },
  "integrationMemberships": [
    {}
  ]
}

Path Parameters

user
integer
required

User ID

Body

application/json
unit
integer
required

Unit ID

userTypes
integer[]

User type IDs

Response

Unit membership created

id
integer
Example:

1

abilities
object

Permission abilities when permissions relation loaded

unit
object
department
object

Department when loaded

userTypes
object[]

User types when loaded

permissions
object

Current user permission flags when includePermissions set

integrationMemberships
object[]

Integration memberships when loaded