Build inbox link

curl --request POST \
  --url https://openapi.enginy.ai/v1/inbox/link \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "folder": "unread",
  "channel": [
    "LINKEDIN",
    "EMAIL"
  ],
  "tagIds": [
    5,
    8
  ]
}
'

import requests

url = "https://openapi.enginy.ai/v1/inbox/link"

payload = {
    "folder": "unread",
    "channel": ["LINKEDIN", "EMAIL"],
    "tagIds": [5, 8]
}
headers = {
    "x-api-key": "<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>', 'Content-Type': 'application/json'},
  body: JSON.stringify({folder: 'unread', channel: ['LINKEDIN', 'EMAIL'], tagIds: [5, 8]})
};

fetch('https://openapi.enginy.ai/v1/inbox/link', 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://openapi.enginy.ai/v1/inbox/link",
  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([
    'folder' => 'unread',
    'channel' => [
        'LINKEDIN',
        'EMAIL'
    ],
    'tagIds' => [
        5,
        8
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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://openapi.enginy.ai/v1/inbox/link"

	payload := strings.NewReader("{\n  \"folder\": \"unread\",\n  \"channel\": [\n    \"LINKEDIN\",\n    \"EMAIL\"\n  ],\n  \"tagIds\": [\n    5,\n    8\n  ]\n}")

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

	req.Header.Add("x-api-key", "<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))

}

HttpResponse<String> response = Unirest.post("https://openapi.enginy.ai/v1/inbox/link")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"folder\": \"unread\",\n  \"channel\": [\n    \"LINKEDIN\",\n    \"EMAIL\"\n  ],\n  \"tagIds\": [\n    5,\n    8\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://openapi.enginy.ai/v1/inbox/link")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"folder\": \"unread\",\n  \"channel\": [\n    \"LINKEDIN\",\n    \"EMAIL\"\n  ],\n  \"tagIds\": [\n    5,\n    8\n  ]\n}"

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

{
  "status": "success",
  "message": "Inbox link built successfully",
  "data": {
    "url": "https://app.enginy.ai/inbox?folder=unread&tagIds=%5B5%2C8%5D&channel=%5B%22LINKEDIN%22%2C%22EMAIL%22%5D"
  }
}

Inbox

Build inbox link

Build a deep-link URL into the user's /inbox view with the given filters applied. Use when the user asks to be sent to / shown / opened an inbox view, or when a reply benefits from a clickable link to actionable inbox state ("here are the 3 unread WhatsApp threads — open them: <link>"). Do NOT call this to FETCH messages — use list_inbox_threads or get_inbox_contact_messages for data. Notes: - All fields are optional; omitting filters returns the default inbox URL. - folder defaults to 'received'. Common alternatives: 'unread', 'ai_draft', 'tags'. - leadId opens a SINGLE contact thread; leadIds filters the LIST view to those contacts. Almost always prefer leadIds. - Resolve names to numeric IDs first via get_identities / get_campaigns / get_companies / list_inbox_tags when the user gives names. - Pure URL construction — no DB read, no side effects. > **Required scope:** `MESSAGING_READ` > > **Rate limit:** 100 requests per minute

POST

inbox

link

Build inbox link

curl --request POST \
  --url https://openapi.enginy.ai/v1/inbox/link \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "folder": "unread",
  "channel": [
    "LINKEDIN",
    "EMAIL"
  ],
  "tagIds": [
    5,
    8
  ]
}
'

import requests

url = "https://openapi.enginy.ai/v1/inbox/link"

payload = {
    "folder": "unread",
    "channel": ["LINKEDIN", "EMAIL"],
    "tagIds": [5, 8]
}
headers = {
    "x-api-key": "<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>', 'Content-Type': 'application/json'},
  body: JSON.stringify({folder: 'unread', channel: ['LINKEDIN', 'EMAIL'], tagIds: [5, 8]})
};

fetch('https://openapi.enginy.ai/v1/inbox/link', 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://openapi.enginy.ai/v1/inbox/link",
  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([
    'folder' => 'unread',
    'channel' => [
        'LINKEDIN',
        'EMAIL'
    ],
    'tagIds' => [
        5,
        8
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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://openapi.enginy.ai/v1/inbox/link"

	payload := strings.NewReader("{\n  \"folder\": \"unread\",\n  \"channel\": [\n    \"LINKEDIN\",\n    \"EMAIL\"\n  ],\n  \"tagIds\": [\n    5,\n    8\n  ]\n}")

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

	req.Header.Add("x-api-key", "<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))

}

HttpResponse<String> response = Unirest.post("https://openapi.enginy.ai/v1/inbox/link")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"folder\": \"unread\",\n  \"channel\": [\n    \"LINKEDIN\",\n    \"EMAIL\"\n  ],\n  \"tagIds\": [\n    5,\n    8\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://openapi.enginy.ai/v1/inbox/link")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"folder\": \"unread\",\n  \"channel\": [\n    \"LINKEDIN\",\n    \"EMAIL\"\n  ],\n  \"tagIds\": [\n    5,\n    8\n  ]\n}"

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

{
  "status": "success",
  "message": "Inbox link built successfully",
  "data": {
    "url": "https://app.enginy.ai/inbox?folder=unread&tagIds=%5B5%2C8%5D&channel=%5B%22LINKEDIN%22%2C%22EMAIL%22%5D"
  }
}

Authorizations

x-api-key

string

header

required

Body

application/json

folder

enum<string>

Top-level inbox section. Defaults to 'received'. Use 'unread' for new replies, 'ai_draft' for pending AI drafts, 'sent', 'scheduled', or 'tags'.

Available options:

received,

unread,

sent,

scheduled,

ai_draft,

tags

Example:

"unread"

tagFolderId

integer

Optional tag-folder ID to scope a tags-section view.

identityIds

integer[]

Filter to threads owned by these sender identity IDs. Look up via get_identities if the user gave names.

Minimum array length: 1

leadId

integer

Open a SINGLE contact thread in the inbox. Almost always prefer leadIds; use leadId only when the user wants a specific contact thread opened.

archived

boolean

If true, link to the archived inbox instead of the active inbox.

status

enum<string>[]

Filter by conversation status. ACTIVE, PAUSED, or COMPLETED.

Minimum array length: 1

Available options:

PAUSED,

ACTIVE,

COMPLETED

tagIds

integer[]

Filter to threads tagged with these tag IDs. Look up via list_inbox_tags if the user gave tag names.

Minimum array length: 1

includeUntagged

boolean

When combined with tagIds (or alone), also include threads with no tag.

campaignIds

integer[]

Filter to threads from these campaigns. Look up via get_campaigns if the user gave campaign names.

Minimum array length: 1

channel

enum<string>[]

Filter by message channel. LINKEDIN, EMAIL, WHATSAPP, or TASK.

Minimum array length: 1

Available options:

LINKEDIN,

EMAIL,

WHATSAPP,

TASK

companyIds

integer[]

Filter to threads with contacts at these companies. Look up via get_companies if the user gave company names.

Minimum array length: 1

icpRate

enum<string>[]

Filter by ICP rating. HIGH, MEDIUM, LOW, DISQUALIFIED, or MISSING_DATA.

Minimum array length: 1

Available options:

HIGH,

MEDIUM,

LOW,

DISQUALIFIED,

MISSING_DATA

dateRange

object

Filter by message date range, inclusive.

Show child attributes

leadIds

integer[]

Filter the inbox list to these contact (lead) IDs. Use this — not leadId — for filter-style scoping.

Minimum array length: 1

Response

200 - application/json

Inbox link built successfully

status

enum<string>

required

Available options:

success

message

string

required

data

object

required

Show child attributes

Get inbox contact messages List inbox tags

API documentation

Endpoints

Build inbox link

Authorizations

Body

Response