Skip to main content
PUT
/
user
/
add-permissions
Add permissions to a user
curl --request PUT \
  --url http://localhost:2000/user/add-permissions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payload": {
    "userId": "68bb46bb4db8c853599f1ebb",
    "permissions": [
      "compass.dashboard.*",
      "compass.dashboard.overview"
    ]
  }
}
'
import requests

url = "http://localhost:2000/user/add-permissions"

payload = { "payload": {
"userId": "68bb46bb4db8c853599f1ebb",
"permissions": ["compass.dashboard.*", "compass.dashboard.overview"]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
payload: {
userId: '68bb46bb4db8c853599f1ebb',
permissions: ['compass.dashboard.*', 'compass.dashboard.overview']
}
})
};

fetch('http://localhost:2000/user/add-permissions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "2000",
CURLOPT_URL => "http://localhost:2000/user/add-permissions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'payload' => [
'userId' => '68bb46bb4db8c853599f1ebb',
'permissions' => [
'compass.dashboard.*',
'compass.dashboard.overview'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "http://localhost:2000/user/add-permissions"

payload := strings.NewReader("{\n \"payload\": {\n \"userId\": \"68bb46bb4db8c853599f1ebb\",\n \"permissions\": [\n \"compass.dashboard.*\",\n \"compass.dashboard.overview\"\n ]\n }\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("http://localhost:2000/user/add-permissions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"payload\": {\n \"userId\": \"68bb46bb4db8c853599f1ebb\",\n \"permissions\": [\n \"compass.dashboard.*\",\n \"compass.dashboard.overview\"\n ]\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:2000/user/add-permissions")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payload\": {\n \"userId\": \"68bb46bb4db8c853599f1ebb\",\n \"permissions\": [\n \"compass.dashboard.*\",\n \"compass.dashboard.overview\"\n ]\n }\n}"

response = http.request(request)
puts response.read_body
{
  "message": "Successfully added permissions for this user.",
  "data": {}
}
{
"errorMessage": "User with this ID does not exist anymore"
}
Adds one or more permissions to a user’s existing permissions list. Only admin-level users can perform this action.

Request

Headers

NameTypeRequiredDescription
AuthorizationstringYesBearer token
Content-TypestringYesapplication/json

Request Body

{
  "payload": {
    "userId": "68bb46bb4db8c853599f1ebb",
    "permissions": [
      "compass.dashboard.*",
      "compass.dashboard.overview"
    ]
  }
}

Request Body Schema

FieldTypeRequiredDescription
payloadobjectYesAdd permissions payload
payload.userIdstringYesThe ID of the user to update
payload.permissionsarrayYesList of permissions to add

Permission Format

Permissions follow the pattern: compass.module.action
  • Use * as wildcard (e.g., compass.dashboard.*)
  • Specific actions (e.g., compass.dashboard.overview)
  • Module-level access (e.g., compass.emailmeter)

Response

200 OK - Successfully added permissions

{
  "message": "Successfully added permissions for this user.",
  "data": {}
}

400 Bad Request

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid payload or missing required fields"
  }
}

401 Unauthorized

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid authentication token"
  }
}

403 Forbidden

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient permissions"
  }
}

404 Not Found

{
  "error": {
    "code": "USER_NOT_FOUND",
    "message": "User with this ID does not exist anymore"
  }
}

500 Internal Server Error

{
  "error": {
    "code": "SERVER_ERROR",
    "message": "Internal server error"
  }
}

Example

curl -X PUT 'http://localhost:2000/user/add-permissions' \
  -H 'Authorization: Bearer your-jwt-token' \
  -H 'Content-Type: application/json' \
  -d '{
    "payload": {
      "userId": "68bb46bb4db8c853599f1ebb",
      "permissions": [
        "compass.dashboard.*",
        "compass.dashboard.overview",
        "compass.emailmeter.stats"
      ]
    }
  }'

Notes

  • This is an admin-only endpoint - requires administrative privileges
  • Permissions are added to the user’s existing permissions (not replaced)
  • Duplicate permissions are automatically ignored
  • The user ID must be a valid MongoDB ObjectId
  • Permission strings must follow the defined pattern
  • Changes take effect immediately for the user’s next request
  • Use the /user/remove-permissions endpoint to remove permissions
  • Permission changes are logged for audit purposes

Available Permissions

Common permission patterns:
  • compass.dashboard.* - Full dashboard access
  • compass.dashboard.overview - Dashboard overview only
  • compass.emailmeter.* - Full Email Meter access
  • compass.emailmeter.stats - Email Meter statistics only
  • compass.hubspot.* - Full HubSpot access
  • compass.users.* - User management access
  • compass.departments.* - Department management access

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
payload
object
required

Response

Successfully added permissions

message
string
Example:

"Successfully added permissions for this user."

data
object
Example:
{}