Skip to main content
POST
/
v2.0
/
endpoint
/
notify
Notify a Contact
curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/endpoint/notify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "userId": "user@example.com",
  "text": "inject text",
  "data": {},
  "attachments": [
    {
      "name": "<string>",
      "caption": "<string>",
      "url": "<string>",
      "type": "file"
    }
  ],
  "URLToken": "endpoint-url-token",
  "sessionId": "your-session-id"
}'
"Sucessfully sent message to user"

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Body

application/json
​
userId
string<email>
required
Example:

"user@example.com"

​
text
string
required
Example:

"inject text"

​
data
object
required
​
URLToken
string
required
Example:

"endpoint-url-token"

​
attachments
object[]
  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
  • Option 7
​
sessionId
string
Example:

"your-session-id"

Response

Returns success message.

The response is of type file.

⌘I