Skip to main content
POST
/
v2
/
presence
/
add
Add Presence
curl --request POST \
  --url https://api.velt.dev/v2/presence/add \
  --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>",
    "documentId": "<string>",
    "users": [
      {
        "userId": "<string>",
        "name": "<string>",
        "email": "<string>",
        "status": "<string>"
      }
    ]
  }
}
'
{
  "result": {
    "status": "success",
    "message": "Presence added successfully.",
    "data": {
      "success": true
    }
  }
}
Use this API to add users to the presence list for a document within an organization.

​
Endpoint

POST https://api.velt.dev/v2/presence/add

​
Headers

​
x-velt-api-key
string
required
Your API key.
​
x-velt-auth-token
string
required
Your Auth Token.

​
Body

​
Params

​
data
object
required

​
Example Requests

​
Add a single user to presence

{
  "data": {
    "organizationId": "org-123",
    "documentId": "doc-456",
    "users": [
      {
        "userId": "user-1",
        "name": "User Name",
        "email": "user@example.com",
        "status": "online"
      }
    ]
  }
}

​
Add multiple users to presence

{
  "data": {
    "organizationId": "org-123",
    "documentId": "doc-456",
    "users": [
      {
        "userId": "user-1",
        "name": "User Name",
        "email": "user@example.com"
      },
      {
        "userId": "user-2",
        "name": "Another User",
        "email": "another@example.com",
        "status": "away"
      }
    ]
  }
}

​
Response

​
Success Response

{
  "result": {
    "status": "success",
    "message": "Presence added successfully.",
    "data": {
      "success": true
    }
  }
}

​
Failure Response

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

{
  "result": {
    "status": "success",
    "message": "Presence added successfully.",
    "data": {
      "success": true
    }
  }
}