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>"
}
}
}'
{
"result": {
"status": "success",
"message": "User config set successfully.",
"data": {
"USER_ID1": {
"success": true,
"userId": "USER_ID1",
"documentId": "doc1",
"message": "User config set successfully."
}
}
}
}
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>"
}
}
}'
{
"result": {
"status": "success",
"message": "User config set successfully.",
"data": {
"USER_ID1": {
"success": true,
"userId": "USER_ID1",
"documentId": "doc1",
"message": "User config set successfully."
}
}
}
}
POST https://api.velt.dev/v1/notifications/config/set
Show properties
Show properties
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.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.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.{
"data": {
"organizationId": "org1",
"documentIds": ["doc1"],
"userIds":["USER_ID1"],
"config":{
"inbox": "ALL", // ALL | MINE | NONE
"email": "ALL" // ALL | MINE | NONE
}
}
}
{
"result": {
"status": "success",
"message": "User config set successfully.",
"data": {
"USER_ID1": {
"success": true,
"userId": "USER_ID1",
"documentId": "doc1",
"message": "User config set successfully."
}
}
}
}
{
"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."
}
}
}
}
Was this page helpful?