Set Config

POST /v1/notifications/config/set

Set Config

cURL

curl --request POST \
  --url https://api.velt.dev/v1/notifications/config/set \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "organizationId": "<string>",
    "documentIds": [
      "<string>"
    ],
    "userIds": [
      "<string>"
    ],
    "config": {
      "inbox": "<string>",
      "email": "<string>",
      "slack": "<string>"
    }
  }
}
'

import requests

url = "https://api.velt.dev/v1/notifications/config/set"

payload = { "data": {
        "organizationId": "<string>",
        "documentIds": ["<string>"],
        "userIds": ["<string>"],
        "config": {
            "inbox": "<string>",
            "email": "<string>",
            "slack": "<string>"
        }
    } }
headers = {
    "x-velt-api-key": "<x-velt-api-key>",
    "x-velt-auth-token": "<x-velt-auth-token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-velt-api-key': '<x-velt-api-key>',
    'x-velt-auth-token': '<x-velt-auth-token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    data: {
      organizationId: '<string>',
      documentIds: ['<string>'],
      userIds: ['<string>'],
      config: {inbox: '<string>', email: '<string>', slack: '<string>'}
    }
  })
};

fetch('https://api.velt.dev/v1/notifications/config/set', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.velt.dev/v1/notifications/config/set",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'organizationId' => '<string>',
        'documentIds' => [
                '<string>'
        ],
        'userIds' => [
                '<string>'
        ],
        'config' => [
                'inbox' => '<string>',
                'email' => '<string>',
                'slack' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-velt-api-key: <x-velt-api-key>",
    "x-velt-auth-token: <x-velt-auth-token>"
  ],
]);

$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 := "https://api.velt.dev/v1/notifications/config/set"

	payload := strings.NewReader("{\n  \"data\": {\n    \"organizationId\": \"<string>\",\n    \"documentIds\": [\n      \"<string>\"\n    ],\n    \"userIds\": [\n      \"<string>\"\n    ],\n    \"config\": {\n      \"inbox\": \"<string>\",\n      \"email\": \"<string>\",\n      \"slack\": \"<string>\"\n    }\n  }\n}")

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

	req.Header.Add("x-velt-api-key", "<x-velt-api-key>")
	req.Header.Add("x-velt-auth-token", "<x-velt-auth-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.post("https://api.velt.dev/v1/notifications/config/set")
  .header("x-velt-api-key", "<x-velt-api-key>")
  .header("x-velt-auth-token", "<x-velt-auth-token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"organizationId\": \"<string>\",\n    \"documentIds\": [\n      \"<string>\"\n    ],\n    \"userIds\": [\n      \"<string>\"\n    ],\n    \"config\": {\n      \"inbox\": \"<string>\",\n      \"email\": \"<string>\",\n      \"slack\": \"<string>\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.velt.dev/v1/notifications/config/set")

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

request = Net::HTTP::Post.new(url)
request["x-velt-api-key"] = '<x-velt-api-key>'
request["x-velt-auth-token"] = '<x-velt-auth-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"organizationId\": \"<string>\",\n    \"documentIds\": [\n      \"<string>\"\n    ],\n    \"userIds\": [\n      \"<string>\"\n    ],\n    \"config\": {\n      \"inbox\": \"<string>\",\n      \"email\": \"<string>\",\n      \"slack\": \"<string>\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
    "result": {
        "status": "success",
        "message": "User config set successfully.",
        "data": {
            "USER_ID1": {
                "success": true,
                "userId": "USER_ID1",
                "documentId": "doc1",
                "message": "User config set successfully."
            }
        }
    }
}

To use this API, you must have the this feature enabled in Velt console

Use this API to set the notifications config for users.

Endpoint

POST https://api.velt.dev/v1/notifications/config/set

Headers

x-velt-api-key · string · required

Your API key.

x-velt-auth-token · string · required

Your Auth Token.

Body

Params

data · object · required

Show properties

organizationId · string · required

The ID of the organization.

documentIds · string[] · required

An array of document IDs. The notification configuration will be applied to these documents for the specified users.

userIds · string[] · required

An array of user IDs. The notification configuration will be set for these users.

config · object · required

Object containing the notification preferences.

Show properties

inbox · string

In-app inbox notification preference. Valid values:

• ALL: User receives all notifications in their inbox.
• MINE: User receives notifications in their inbox only for activities directly involving them (e.g., mentions, replies).
• NONE: User receives no notifications in their inbox.

Optional.

email · string

Email notification preference. Valid values:

• ALL: User receives email notifications for all activities.
• MINE: User receives email notifications only for activities directly involving them.
• NONE: User receives no email notifications.

Optional.

slack · string

Slack notification preference (requires Slack integration to be effective). Valid values:

• ALL: User receives Slack notifications for all activities.
• MINE: User receives Slack notifications only for activities directly involving them.
• NONE: User receives no Slack notifications.

Optional.

Example Request

{
    "data": {
        "organizationId": "org1",
        "documentIds": ["doc1"],
        "userIds":["USER_ID1"],
        "config":{
            "inbox": "ALL", // ALL | MINE | NONE
            "email": "ALL" // ALL | MINE | NONE
        }
    }
}

Response

Success Response

{
    "result": {
        "status": "success",
        "message": "User config set successfully.",
        "data": {
            "USER_ID1": {
                "success": true,
                "userId": "USER_ID1",
                "documentId": "doc1",
                "message": "User config set successfully."
            }
        }
    }
}

Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}

{
    "result": {
        "status": "success",
        "message": "User config set successfully.",
        "data": {
            "USER_ID1": {
                "success": true,
                "userId": "USER_ID1",
                "documentId": "doc1",
                "message": "User config set successfully."
            }
        }
    }
}