Create Organization Mention
curl --request POST \
--url https://api.eqho.ai/v1/mentions \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'x-org-id: <api-key>' \
--data '
{
"description": "The favorite color of the lead",
"display_name": "favorite_color",
"tags": [
"custom_fields"
]
}
'import requests
url = "https://api.eqho.ai/v1/mentions"
payload = {
"description": "The favorite color of the lead",
"display_name": "favorite_color",
"tags": ["custom_fields"]
}
headers = {
"X-API-KEY": "<api-key>",
"x-org-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-KEY': '<api-key>',
'x-org-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
description: 'The favorite color of the lead',
display_name: 'favorite_color',
tags: ['custom_fields']
})
};
fetch('https://api.eqho.ai/v1/mentions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.eqho.ai/v1/mentions"
payload := strings.NewReader("{\n \"description\": \"The favorite color of the lead\",\n \"display_name\": \"favorite_color\",\n \"tags\": [\n \"custom_fields\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("x-org-id", "<api-key>")
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))
}{
"display_name": "<string>",
"id": "<string>",
"account_id": "<string>",
"tags": [
"global"
],
"mention": "<string>",
"description": "<string>",
"enabled": true,
"history": {
"last_modified_at": "2023-11-07T05:31:56Z",
"revision": 0,
"created_at": "2023-11-07T05:31:56Z",
"created_by": "unknown",
"last_modified_by": "unknown"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Mentions
Create Mention
POST
/
v1
/
mentions
Create Organization Mention
curl --request POST \
--url https://api.eqho.ai/v1/mentions \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'x-org-id: <api-key>' \
--data '
{
"description": "The favorite color of the lead",
"display_name": "favorite_color",
"tags": [
"custom_fields"
]
}
'import requests
url = "https://api.eqho.ai/v1/mentions"
payload = {
"description": "The favorite color of the lead",
"display_name": "favorite_color",
"tags": ["custom_fields"]
}
headers = {
"X-API-KEY": "<api-key>",
"x-org-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-KEY': '<api-key>',
'x-org-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
description: 'The favorite color of the lead',
display_name: 'favorite_color',
tags: ['custom_fields']
})
};
fetch('https://api.eqho.ai/v1/mentions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.eqho.ai/v1/mentions"
payload := strings.NewReader("{\n \"description\": \"The favorite color of the lead\",\n \"display_name\": \"favorite_color\",\n \"tags\": [\n \"custom_fields\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("x-org-id", "<api-key>")
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))
}{
"display_name": "<string>",
"id": "<string>",
"account_id": "<string>",
"tags": [
"global"
],
"mention": "<string>",
"description": "<string>",
"enabled": true,
"history": {
"last_modified_at": "2023-11-07T05:31:56Z",
"revision": 0,
"created_at": "2023-11-07T05:31:56Z",
"created_by": "unknown",
"last_modified_by": "unknown"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
APIKeyHeader & OrgImpersonationOAuth2PasswordBearer & OrgImpersonation
Your API key for authentication.
Org impersonation via x-org-id. Superadmins may impersonate any org; admins may impersonate their direct sub-organizations. Enter the target organization ID to act as that org.
Body
application/json
Available options:
global, lead, time, agent, action, system_prompt, extracted_data, custom_fields, campaign, role, script, conversation, inferred The mention in {{field}} (Jinja) format.
Example:
"{{lead.name}}"
Response
Successful Response
Available options:
global, lead, time, agent, action, system_prompt, extracted_data, custom_fields, campaign, role, script, conversation, inferred Show child attributes
Show child attributes
Was this page helpful?