Skip to main content
POST
/
v1
/
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
  ]
}
'
{
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.enginy.ai/llms.txt

Use this file to discover all available pages before exploring further.

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.

​
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