{ "openapi": "3.1.0", "info": { "title": "Inboxapp API", "version": "2.0.0", "description": "The Inboxapp API gives you access to your team's conversations and the CRM state around them. Every platform uses the same resources, so your code asks what an account can do instead of which platform it is on.\n\n## The data model\n\n```txt\nTeam\n├── Members people on your team\n├── Account links your accounts on each platform\n│ └── Threads one conversation with one profile\n│ └── Messages\n├── Contacts your record of a person\n│ └── Profiles their account on each platform\n├── Tags labels on contacts\n└── Statuses pipeline stages of contacts\n```\n\n| Resource | What it is |\n| --- | --- |\n| **Platform** | A messaging platform available to your team, with what it supports |\n| **Account link** | One of your accounts on a platform. Messages are sent from one |\n| **Profile** | One person's account on one platform |\n| **Contact** | Your team's record of a person. Groups one or more of their profiles |\n| **Thread** | A conversation between one account link and one profile |\n| **Message** | A message in a thread, which you can send, edit, unsend and react to |\n| **Tag** | A label on a contact. A contact can have several |\n| **Status** | A pipeline stage. A contact has at most one |\n| **Member** | A person on your team, who can be assigned threads and contacts |\n\n## Authentication\n\nSend your API token in the `Authorization` header: `Authorization: Bearer `. The token decides the team, so no path or parameter names one.\n\n## Member view\n\nSome state belongs to one member rather than the team: each member has their own read status for a thread. The API isn't a member, so it takes the team owner's view. A thread's `unread` is whether the owner has it unread, and setting it marks the thread read or unread for the owner.\n\n## Profiles and contacts\n\nA **profile** holds what the platform says about a person: `username`, `displayName`, `bio`, follower counts. A **contact** holds what your team says about them: `statusId`, `tagIds`, `notes`, `valuation`, `assigneeId`. A contact groups one or more profiles.\n\nA thread is always with one profile, and its `contactId` points to the contact that profile belongs to.\n\n```json\n{\n \"id\": \"nq2r8v5ycx1t7m4hj6kd3wzb\",\n \"profiles\": [\n {\n \"id\": \"n7kxqm5d9iu2sgdf6jbw4h36\",\n \"platform\": \"twitter\",\n \"platformId\": \"1876543210987654321\",\n \"username\": \"sarahchen\",\n \"handle\": \"@sarahchen\",\n \"displayName\": \"Sarah Chen\"\n }\n ],\n \"statusId\": \"r3km7xj9wq5p2bvnhfdteoly\",\n \"tagIds\": [\"t9wq5p2bvnhfdteolyr3km7x\"],\n \"notes\": \"Asked for a demo of the reporting API.\",\n \"valuation\": 12000,\n \"assigneeId\": null\n}\n```\n\nReads never create a contact. Someone your team has never talked to or imported has none: message them by sending to a `profile` target.\n\n## IDs\n\n| Field | What it is | Use it for |\n| --- | --- | --- |\n| `id`, every `…Id` | An Inboxapp ID | Paths and references. Paths only take Inboxapp IDs |\n| `platformId` | The ID the platform gives the object: its user, conversation or message | Matching against your own data |\n\nA `platformId` always comes with a `platform`, and means nothing without it. To find a resource by its platform identity, filter its collection:\n\n```txt\nGET /contacts?platform=twitter&platformId=1876543210987654321\n```\n\nNo match is an empty `data` array, never a `404`.\n\n## Platforms and capabilities\n\nPlatforms differ: one lets you edit a message, another doesn't. The API expresses that as **capabilities** instead of per-platform endpoints. `GET /platforms` lists the platforms available to your team, with their capabilities and limits.\n\n```txt\nPlatform capabilities the most any account on the platform can do\n └── Account link capabilities narrowed for this account\n └── Thread restrictions disabled in this conversation\n```\n\nCheck both before you call:\n\n```typescript\nfunction canEdit(accountLink: AccountLink, thread: Thread): boolean {\n return (\n accountLink.capabilities.includes(\"message:edit\") &&\n !thread.restrictions.includes(\"message:edit\")\n );\n}\n```\n\n| Failure | Meaning |\n| --- | --- |\n| `422 capabilityNotSupported` | The account link can't do this |\n| `422 threadRestricted` | The platform disabled it in this conversation |\n| `422 mutationWindowClosed` | The platform's time window for it has passed |\n| `403 platformNotAvailable` | The resource is on a platform your team can't use |\n\nNew platforms may be added within v2, so treat `platform` as an open string. Code that checks capabilities keeps working when they are. See [Platforms and capabilities](https://docs.inboxapp.com/v2/platforms) for what each platform supports.\n\n## Platform data\n\nFields every platform has are top-level. Fields only one platform has are in `platformData`, tagged by `_tag`:\n\n```json\n{\n \"platformData\": { \"_tag\": \"twitter\", \"encrypted\": true }\n}\n```\n\nIgnore tags you don't know.\n\n## Responses\n\nEvery documented field is present: a value that doesn't apply is `null`. Timestamps are ISO 8601 in UTC. Within v2, fields, enum values and error codes may be added, so ignore unknown fields and handle unknown enum values.\n\n## Pagination\n\nCollections return `{ \"data\": [...], \"nextCursor\": \"...\" }`. Pass `nextCursor` back as `cursor`, with the same filters, to read the next page. It is `null` on the last page. `limit` defaults to 50, up to 100. See [Pagination](https://docs.inboxapp.com/v2/reference/pagination).\n\n## Query parameters\n\nTo pass several values, repeat the key:\n\n```txt\n?accountLinkId=a&accountLinkId=b\n```\n\nBrackets (`ids[]=…`) and comma-separated values aren't accepted. See [Query parameters](https://docs.inboxapp.com/v2/reference/query-parameters).\n\n## Expansion\n\nReferences are IDs by default. Use `expand` to embed the related resource next to its ID field, `contact` beside `contactId`, at most 4 per request:\n\n```txt\nGET /threads?expand=contact&expand=profile\n```\n\n## Updates\n\nIn `PATCH` bodies, omitted fields are left unchanged, and `null` clears a nullable field.\n\n## Errors\n\nEvery error has the same body:\n\n```json\n{\n \"code\": \"capabilityNotSupported\",\n \"message\": \"This account can't perform this operation.\",\n \"details\": { \"capability\": \"message:edit\" },\n \"requestId\": \"…\"\n}\n```\n\nBranch on `code`, the contract. `message` can be shown to a person and may change. `details` is `null` or the object documented for that code. Share `requestId`, also in the `X-Request-Id` header, when you contact support. See [Error codes](https://docs.inboxapp.com/v2/reference/errors).\n\n## Sending safely\n\n`POST /messages` takes an optional `Idempotency-Key` header. Retrying with the same key never sends twice: a replay returns the original result. Without a key, a retry can send twice.\n\n## Rate limits\n\nEach team can make 300 requests per minute, 10,000 per hour and 100,000 per day. Every response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`. Past a limit, requests fail with `429 rateLimited` and a `Retry-After` header. See [Rate limits](https://docs.inboxapp.com/v2/reference/rate-limits).", "summary": "Read and act on your team's conversations across messaging platforms." }, "paths": { "/platforms": { "get": { "tags": ["Platforms"], "operationId": "platforms.list", "parameters": [], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PlatformInfo" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "description": "Each platform's capabilities and limits. An account link's `capabilities` can only narrow its platform's.", "summary": "List platforms" } }, "/team": { "get": { "tags": ["Team"], "operationId": "team.get", "parameters": [], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Get team" } }, "/members": { "get": { "tags": ["Team"], "operationId": "team.listMembers", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Page size, from 1 to 100. Defaults to 50." }, "required": false }, { "name": "cursor", "in": "query", "schema": { "type": "string", "description": "The previous page's `nextCursor`. Opaque, and valid only with the filters it was issued for." }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberPage" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidCursor" }, { "$ref": "#/components/schemas/InvalidRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "List members" } }, "/members/{memberId}": { "get": { "tags": ["Team"], "operationId": "team.getMember", "parameters": [ { "name": "memberId", "in": "path", "schema": { "$ref": "#/components/schemas/Cuid2" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Member" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberNotFound" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Get member" } }, "/account-links": { "get": { "tags": ["Account Links"], "operationId": "accountLinks.list", "parameters": [ { "name": "platform", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Platform" }, "description": "Repeat the key to match any of several." }, "required": false }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": ["active", "offline", "paused"], "description": "`active` sends and syncs. `paused` is stopped for the reasons in `pauseReasons`, and resumes once none remain. `offline` lost its connection to the platform and must be reconnected in Inboxapp." }, "description": "Repeat the key to match any of several." }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Page size, from 1 to 100. Defaults to 50." }, "required": false }, { "name": "cursor", "in": "query", "schema": { "type": "string", "description": "The previous page's `nextCursor`. Opaque, and valid only with the filters it was issued for." }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountLinkPage" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidCursor" }, { "$ref": "#/components/schemas/InvalidRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformNotAvailable" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "List account links" } }, "/account-links/{accountLinkId}": { "get": { "tags": ["Account Links"], "operationId": "accountLinks.get", "parameters": [ { "name": "accountLinkId", "in": "path", "schema": { "$ref": "#/components/schemas/Cuid2" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountLink" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformNotAvailable" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountLinkNotFound" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Get account link" } }, "/contacts": { "get": { "tags": ["Contacts"], "operationId": "contacts.list", "parameters": [ { "name": "platform", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Platform" }, "description": "Contacts with a profile on these platforms. Defaults to every platform available to the team. `platformId` needs exactly one. Repeat the key to match any of several." }, "required": false }, { "name": "platformId", "in": "query", "schema": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Contacts with a profile of this platform ID. Give one of `platformId`, `username` or `q`, repeating the key for up to 100. No match is an empty page.", "maxItems": 100 }, "required": false }, { "name": "username", "in": "query", "schema": { "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Contacts with a profile of this username, without its display prefix. One username may match several contacts. Give one of `platformId`, `username` or `q`, repeating the key for up to 100. No match is an empty page.", "maxItems": 100 }, "required": false }, { "name": "q", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 200, "description": "Searches contact and profile names, usernames, emails and phone numbers. Not combinable with `platformId` or `username`. Results follow `createdAt`, not relevance, and can trail changes by a few seconds." }, "required": false }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": ["status", "tags", "assignee"] }, "description": "Related resources to embed next to their ID field, one path per key, at most 4.", "maxItems": 4 }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Page size, from 1 to 100. Defaults to 50." }, "required": false }, { "name": "cursor", "in": "query", "schema": { "type": "string", "description": "The previous page's `nextCursor`. Opaque, and valid only with the filters it was issued for." }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPage" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidCursor" }, { "$ref": "#/components/schemas/InvalidRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformNotAvailable" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "description": "Finds contacts by the platform identity of one of their profiles: a `platform` with `platformId` or `username`.", "summary": "Find contacts", "x-mcp-hints": { "openWorldHint": true } } }, "/contacts/{contactId}": { "get": { "tags": ["Contacts"], "operationId": "contacts.get", "parameters": [ { "name": "contactId", "in": "path", "schema": { "$ref": "#/components/schemas/Cuid2" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": ["status", "tags", "assignee"] }, "description": "Related resources to embed next to their ID field, one path per key, at most 4.", "maxItems": 4 }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformNotAvailable" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactNotFound" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Get contact", "x-mcp-hints": { "openWorldHint": true } }, "patch": { "tags": ["Contacts"], "operationId": "contacts.update", "parameters": [ { "name": "contactId", "in": "path", "schema": { "$ref": "#/components/schemas/Cuid2" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformNotAvailable" }, { "$ref": "#/components/schemas/WorkspaceLocked" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactNotFound" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Update contact", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactUpdate" } } }, "required": true }, "x-mcp-hints": { "destructiveHint": true } } }, "/contacts/{contactId}/tags/{tagRef}": { "put": { "tags": ["Contacts"], "operationId": "contacts.addTag", "parameters": [ { "name": "contactId", "in": "path", "schema": { "$ref": "#/components/schemas/Cuid2" }, "required": true }, { "name": "tagRef", "in": "path", "schema": { "type": "string", "description": "A tag, by ID or by name. Names match ignoring case and accents. When a value is one tag's ID and another's name, the ID wins." }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformNotAvailable" }, { "$ref": "#/components/schemas/WorkspaceLocked" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ContactNotFound" }, { "$ref": "#/components/schemas/TagNotFound" } ] } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "description": "Adding a tag the contact already has succeeds.", "summary": "Add tag to contact" }, "delete": { "tags": ["Contacts"], "operationId": "contacts.removeTag", "parameters": [ { "name": "contactId", "in": "path", "schema": { "$ref": "#/components/schemas/Cuid2" }, "required": true }, { "name": "tagRef", "in": "path", "schema": { "type": "string", "description": "A tag, by ID or by name. Names match ignoring case and accents. When a value is one tag's ID and another's name, the ID wins." }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformNotAvailable" }, { "$ref": "#/components/schemas/WorkspaceLocked" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ContactNotFound" }, { "$ref": "#/components/schemas/TagNotFound" } ] } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "description": "Removing a tag the contact doesn't have succeeds.", "summary": "Remove tag from contact", "x-mcp-hints": { "destructiveHint": false } } }, "/people": { "get": { "tags": ["People"], "operationId": "people.search", "parameters": [ { "name": "platform", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Platform" }, "description": "Searches these platforms. Defaults to every available platform. With `accountLinkId`, keeps only the account links on these platforms. Repeat the key to match any of several." }, "required": false }, { "name": "accountLinkId", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Cuid2" }, "description": "Searches from these account links. Each platform is searched once, from the oldest account link given on it; IDs that match no account link are ignored. Without it, each platform is searched from its oldest active account link that can search. Repeat the key to match any of several." }, "required": false }, { "name": "q", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 100, "description": "A name or username, as typed into the platform's own people search." }, "required": true }, { "name": "reach", "in": "query", "schema": { "type": "string", "enum": ["contacts", "network"], "description": "`contacts`, the default, searches people each account already messages. `network` also searches beyond them, where the platform separates the two." }, "required": false }, { "name": "enrich", "in": "query", "schema": { "type": "boolean", "description": "`true` fetches and stores every result Inboxapp hasn't stored yet, so each comes back as a full profile. A result that can't be fetched or stored is left out. Slower. Defaults to `false`." }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonList" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformNotAvailable" }, { "$ref": "#/components/schemas/PlanRequired" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountLinkNotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AccountLinkDisconnected" }, { "$ref": "#/components/schemas/IntegrationSetupRequired" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapabilityNotSupported" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PeopleSearchRateLimited" }, { "$ref": "#/components/schemas/PlatformRateLimited" }, { "$ref": "#/components/schemas/RateLimited" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformUnavailable" } } } } }, "description": "Searches people on each platform as one of the team's account links, like the platform's own search box.\n\nNeeds the Advanced API add-on, and `directory:typeahead` on each account link. Each account link can search 20 times per minute, 300 per hour and 1500 per day, so the platform doesn't flag its session; past a limit, it is listed in `failures` with `peopleSearchRateLimited`.\n\nUse the result's `target` to reach that person on endpoints like `Send message` or `Send connection request`.", "summary": "Search people", "x-mcp-hints": { "openWorldHint": true } } }, "/threads": { "get": { "tags": ["Threads"], "operationId": "threads.list", "parameters": [ { "name": "accountLinkId", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Cuid2" }, "description": "Threads of these account links. Repeat the key to match any of several." }, "required": false }, { "name": "platform", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Platform" }, "description": "Repeat the key to match any of several." }, "required": false }, { "name": "contactId", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Cuid2" }, "description": "Threads with these contacts. With `accountLinkId`, finds the thread between an account and a contact. Repeat the key to match any of several." }, "required": false }, { "name": "folder", "in": "query", "schema": { "type": "string", "enum": ["inbox", "noReply", "requests", "archived", "all"], "description": "Defaults to `inbox`, threads that are neither archived nor requests. `noReply` is the `inbox` threads whose latest activity is inbound. `requests` holds unarchived threads where `isRequest` is true. `archived` includes requests. `all` spans every folder. Every other filter narrows the folder." }, "required": false }, { "name": "tag", "in": "query", "schema": { "type": "array", "items": { "type": "string", "description": "A tag, by ID or by name. Names match ignoring case and accents. When a value is one tag's ID and another's name, the ID wins." }, "description": "Threads whose contact has one of these tags. Repeat the key to match any of several." }, "required": false }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "type": "string", "description": "A status, by ID or by name. Names match ignoring case and accents. When a value is one status's ID and another's name, the ID wins." }, "description": "Threads whose contact has one of these statuses. Repeat the key to match any of several." }, "required": false }, { "name": "assigneeId", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Cuid2" }, "description": "Threads whose `assigneeId`, the thread's own assignee or else its contact's, is one of these members. Repeat the key to match any of several." }, "required": false }, { "name": "unassigned", "in": "query", "schema": { "type": "boolean", "description": "`true` keeps threads with no assignee, including through their contact. Not combinable with `assigneeId`." }, "required": false }, { "name": "campaignId", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Cuid2" }, "description": "Threads these campaigns sent a message in. Campaign sends archive the thread, so pair it with `folder=archived` or `all`. Repeat the key to match any of several." }, "required": false }, { "name": "q", "in": "query", "schema": { "type": "string", "minLength": 1, "description": "Searches profile display names, usernames and the activity preview. Results follow `order`, not relevance." }, "required": false }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": ["desc", "asc"], "description": "Sort direction by inbox order: `activity.at`, or `createdAt` for a thread with no activity. A reminder or an accepted message request moves a thread up until its next message, without changing `activity.at`. Defaults to `desc`, newest first." }, "required": false }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": ["profile", "contact", "accountLink", "assignee"] }, "description": "Related resources to embed next to their ID field, one path per key, at most 4.", "maxItems": 4 }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Page size, from 1 to 100. Defaults to 50." }, "required": false }, { "name": "cursor", "in": "query", "schema": { "type": "string", "description": "The previous page's `nextCursor`. Opaque, and valid only with the filters it was issued for." }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadPage" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidCursor" }, { "$ref": "#/components/schemas/InvalidRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformNotAvailable" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "description": "Threads in inbox order, filtered by folder and by contact CRM state.", "summary": "List threads", "x-mcp-hints": { "openWorldHint": true } } }, "/threads/{threadId}": { "get": { "tags": ["Threads"], "operationId": "threads.get", "parameters": [ { "name": "threadId", "in": "path", "schema": { "$ref": "#/components/schemas/Cuid2" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": ["profile", "contact", "accountLink", "assignee"] }, "description": "Related resources to embed next to their ID field, one path per key, at most 4.", "maxItems": 4 }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Thread" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformNotAvailable" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadNotFound" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Get thread", "x-mcp-hints": { "openWorldHint": true } }, "patch": { "tags": ["Threads"], "operationId": "threads.update", "parameters": [ { "name": "threadId", "in": "path", "schema": { "$ref": "#/components/schemas/Cuid2" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Thread" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformNotAvailable" }, { "$ref": "#/components/schemas/WorkspaceLocked" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadNotFound" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Update thread", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadUpdate" } } }, "required": true }, "x-mcp-hints": { "openWorldHint": true } }, "delete": { "tags": ["Threads"], "operationId": "threads.delete", "parameters": [ { "name": "threadId", "in": "path", "schema": { "$ref": "#/components/schemas/Cuid2" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadDeletion" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformNotAvailable" }, { "$ref": "#/components/schemas/WorkspaceLocked" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadNotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AccountLinkDisconnected" }, { "$ref": "#/components/schemas/IntegrationSetupRequired" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapabilityNotSupported" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformRateLimited" }, { "$ref": "#/components/schemas/RateLimited" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformUnavailable" } } } } }, "description": "Deletes the conversation on the platform when it can, and always in Inboxapp. The response's `scope` says which happened.", "summary": "Delete thread", "x-mcp-hints": { "openWorldHint": true } } }, "/threads/{threadId}/typing": { "post": { "tags": ["Threads"], "operationId": "threads.typing", "parameters": [ { "name": "threadId", "in": "path", "schema": { "$ref": "#/components/schemas/Cuid2" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TypingSignal" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformNotAvailable" }, { "$ref": "#/components/schemas/WorkspaceLocked" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadNotFound" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapabilityNotSupported" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "description": "Shows the account link as typing in the conversation. At most one per thread every 2.5 seconds; extra calls return `skipped`.", "summary": "Send typing indicator", "x-mcp-hints": { "openWorldHint": true } } }, "/threads/{threadId}/messages": { "get": { "tags": ["Messages"], "operationId": "messages.list", "parameters": [ { "name": "threadId", "in": "path", "schema": { "$ref": "#/components/schemas/Cuid2" }, "required": true }, { "name": "order", "in": "query", "schema": { "type": "string", "enum": ["desc", "asc"], "description": "Sort direction by `createdAt`. Defaults to `desc`, newest first." }, "required": false }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "sentBy", "reactions.author", "thread", "accountLink", "replyTo.message" ] }, "description": "Related resources to embed next to their ID field, one path per key, at most 4.", "maxItems": 4 }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Page size, from 1 to 100. Defaults to 50." }, "required": false }, { "name": "cursor", "in": "query", "schema": { "type": "string", "description": "The previous page's `nextCursor`. Opaque, and valid only with the filters it was issued for." }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessagePage" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidCursor" }, { "$ref": "#/components/schemas/InvalidRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformNotAvailable" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadNotFound" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "List messages", "x-mcp-hints": { "openWorldHint": true } } }, "/messages/{messageId}": { "get": { "tags": ["Messages"], "operationId": "messages.get", "parameters": [ { "name": "messageId", "in": "path", "schema": { "$ref": "#/components/schemas/Cuid2" }, "required": true }, { "name": "expand", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "sentBy", "reactions.author", "thread", "accountLink", "replyTo.message" ] }, "description": "Related resources to embed next to their ID field, one path per key, at most 4.", "maxItems": 4 }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformNotAvailable" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageNotFound" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Get message", "x-mcp-hints": { "openWorldHint": true } }, "patch": { "tags": ["Messages"], "operationId": "messages.edit", "parameters": [ { "name": "messageId", "in": "path", "schema": { "$ref": "#/components/schemas/Cuid2" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformNotAvailable" }, { "$ref": "#/components/schemas/WorkspaceLocked" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageNotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AccountLinkDisconnected" }, { "$ref": "#/components/schemas/IntegrationSetupRequired" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ThreadRestricted" }, { "$ref": "#/components/schemas/MutationWindowClosed" }, { "$ref": "#/components/schemas/MessageNotModifiable" }, { "$ref": "#/components/schemas/ContentRejected" }, { "$ref": "#/components/schemas/CapabilityNotSupported" } ] } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformRateLimited" }, { "$ref": "#/components/schemas/RateLimited" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformUnavailable" } } } } }, "description": "Edits the message on the platform. Needs `message:edit`, within the platform's edit window.", "summary": "Edit message", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageEdit" } } }, "required": true }, "x-mcp-hints": { "openWorldHint": true } }, "delete": { "tags": ["Messages"], "operationId": "messages.unsend", "parameters": [ { "name": "messageId", "in": "path", "schema": { "$ref": "#/components/schemas/Cuid2" }, "required": true }, { "name": "scope", "in": "query", "schema": { "type": "string", "enum": ["self", "all"], "description": "`self` deletes for the account link only, which needs `message:delete:self`. `all` unsends for every participant, which needs `message:unsend`." }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageDeletion" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformNotAvailable" }, { "$ref": "#/components/schemas/WorkspaceLocked" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageNotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AccountLinkDisconnected" }, { "$ref": "#/components/schemas/IntegrationSetupRequired" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ThreadRestricted" }, { "$ref": "#/components/schemas/MutationWindowClosed" }, { "$ref": "#/components/schemas/MessageNotModifiable" }, { "$ref": "#/components/schemas/ContentRejected" }, { "$ref": "#/components/schemas/CapabilityNotSupported" } ] } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformRateLimited" }, { "$ref": "#/components/schemas/RateLimited" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformUnavailable" } } } } }, "summary": "Delete message", "x-mcp-hints": { "openWorldHint": true } } }, "/messages": { "post": { "tags": ["Messages"], "operationId": "messages.send", "parameters": [ { "name": "idempotency-key", "in": "header", "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x20-\\x7E]+$", "description": "Makes retries safe: a replay with the same key and body returns the original message. Scoped to the team.", "examples": ["order-4821-followup"] }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendResult" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformNotAvailable" }, { "$ref": "#/components/schemas/PlanRequired" }, { "$ref": "#/components/schemas/WorkspaceLocked" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ThreadNotFound" }, { "$ref": "#/components/schemas/ContactNotFound" }, { "$ref": "#/components/schemas/AccountLinkNotFound" } ] } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SendInProgress" }, { "$ref": "#/components/schemas/AccountLinkDisconnected" }, { "$ref": "#/components/schemas/IntegrationSetupRequired" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/IdempotencyKeyReused" }, { "$ref": "#/components/schemas/ThreadRestricted" }, { "$ref": "#/components/schemas/ContentRejected" }, { "$ref": "#/components/schemas/RecipientUnavailable" }, { "$ref": "#/components/schemas/PlatformNotSupported" }, { "$ref": "#/components/schemas/ProfileAmbiguous" }, { "$ref": "#/components/schemas/CapabilityNotSupported" } ] } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformRateLimited" }, { "$ref": "#/components/schemas/RateLimited" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SendUnconfirmed" }, { "$ref": "#/components/schemas/PlatformError" } ] } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformUnavailable" } } } } }, "description": "`201` for a new send. A replay of an `Idempotency-Key` returns the original result with `200`.", "summary": "Send message", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendRequest" } } }, "required": true }, "x-mcp-hints": { "openWorldHint": true } } }, "/messages/{messageId}/history": { "get": { "tags": ["Messages"], "operationId": "messages.history", "parameters": [ { "name": "messageId", "in": "path", "schema": { "$ref": "#/components/schemas/Cuid2" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageHistory" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformNotAvailable" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageNotFound" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "description": "Every version of the message's content, from its edits.", "summary": "Get message history", "x-mcp-hints": { "openWorldHint": true } } }, "/messages/{messageId}/reactions": { "post": { "tags": ["Messages"], "operationId": "messages.react", "parameters": [ { "name": "messageId", "in": "path", "schema": { "$ref": "#/components/schemas/Cuid2" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reactions" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformNotAvailable" }, { "$ref": "#/components/schemas/WorkspaceLocked" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageNotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AccountLinkDisconnected" }, { "$ref": "#/components/schemas/IntegrationSetupRequired" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ThreadRestricted" }, { "$ref": "#/components/schemas/MutationWindowClosed" }, { "$ref": "#/components/schemas/MessageNotModifiable" }, { "$ref": "#/components/schemas/ContentRejected" }, { "$ref": "#/components/schemas/CapabilityNotSupported" } ] } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformRateLimited" }, { "$ref": "#/components/schemas/RateLimited" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformUnavailable" } } } } }, "summary": "Add reaction", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReactionChange" } } }, "required": true }, "x-mcp-hints": { "idempotentHint": true, "openWorldHint": true } }, "delete": { "tags": ["Messages"], "operationId": "messages.unreact", "parameters": [ { "name": "messageId", "in": "path", "schema": { "$ref": "#/components/schemas/Cuid2" }, "required": true }, { "name": "emoji", "in": "query", "schema": { "type": "string", "pattern": "^(?:\\p{Regional_Indicator}{2}|[#*0-9]\\uFE0F?\\u20E3|\\u{1F3F4}[\\u{E0020}-\\u{E007E}]+\\u{E007F}|\\p{Extended_Pictographic}\\uFE0F?\\p{Emoji_Modifier}?(?:\\u200D\\p{Extended_Pictographic}\\uFE0F?\\p{Emoji_Modifier}?)*)(?![\\s\\S])", "description": "Exactly one emoji.", "examples": ["👍"] }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reactions" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformNotAvailable" }, { "$ref": "#/components/schemas/WorkspaceLocked" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageNotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AccountLinkDisconnected" }, { "$ref": "#/components/schemas/IntegrationSetupRequired" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ThreadRestricted" }, { "$ref": "#/components/schemas/MutationWindowClosed" }, { "$ref": "#/components/schemas/MessageNotModifiable" }, { "$ref": "#/components/schemas/ContentRejected" }, { "$ref": "#/components/schemas/CapabilityNotSupported" } ] } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformRateLimited" }, { "$ref": "#/components/schemas/RateLimited" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformUnavailable" } } } } }, "summary": "Remove reaction", "x-mcp-hints": { "destructiveHint": false, "openWorldHint": true } } }, "/messages/{messageId}/attachments/{index}": { "get": { "tags": ["Messages"], "operationId": "messages.attachment", "parameters": [ { "name": "messageId", "in": "path", "schema": { "$ref": "#/components/schemas/Cuid2" }, "required": true }, { "name": "index", "in": "path", "schema": { "type": "integer", "minimum": 0 }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentMedia" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentMedia" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformNotAvailable" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageNotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AccountLinkDisconnected" }, { "$ref": "#/components/schemas/IntegrationSetupRequired" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapabilityNotSupported" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformRateLimited" }, { "$ref": "#/components/schemas/RateLimited" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformUnavailable" } } } } }, "description": "`200` with a fresh URL once ready, `202` while the media is pending or processing. A card index is `invalidRequest`.", "summary": "Get attachment", "x-mcp-hints": { "openWorldHint": true } } }, "/connection-requests": { "post": { "tags": ["Relationships"], "operationId": "relationships.connect", "parameters": [], "security": [ { "bearerAuth": [] } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionRequest" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformNotAvailable" }, { "$ref": "#/components/schemas/PlanRequired" }, { "$ref": "#/components/schemas/WorkspaceLocked" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ThreadNotFound" }, { "$ref": "#/components/schemas/ContactNotFound" }, { "$ref": "#/components/schemas/AccountLinkNotFound" } ] } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AccountLinkDisconnected" }, { "$ref": "#/components/schemas/IntegrationSetupRequired" } ] } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/RecipientUnavailable" }, { "$ref": "#/components/schemas/PlatformNotSupported" }, { "$ref": "#/components/schemas/ProfileAmbiguous" }, { "$ref": "#/components/schemas/ConnectionRefused" }, { "$ref": "#/components/schemas/CapabilityNotSupported" } ] } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformRateLimited" }, { "$ref": "#/components/schemas/RateLimited" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } }, "502": { "description": "Bad Gateway", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformUnavailable" } } } } }, "description": "Invites a profile to connect with the account link. Needs `profile:connect`.", "summary": "Send connection request", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionRequestCreate" } } }, "required": true }, "x-mcp-hints": { "openWorldHint": true } } }, "/tags": { "get": { "tags": ["Tags"], "operationId": "tags.list", "parameters": [], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagPage" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "List tags" }, "post": { "tags": ["Tags"], "operationId": "tags.create", "parameters": [], "security": [ { "bearerAuth": [] } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tag" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceLocked" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NameTaken" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagLimitReached" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Create tag", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagCreate" } } }, "required": true } } }, "/tags/{tagRef}": { "get": { "tags": ["Tags"], "operationId": "tags.get", "parameters": [ { "name": "tagRef", "in": "path", "schema": { "type": "string", "description": "A tag, by ID or by name. Names match ignoring case and accents. When a value is one tag's ID and another's name, the ID wins." }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tag" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagNotFound" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Get tag" }, "patch": { "tags": ["Tags"], "operationId": "tags.update", "parameters": [ { "name": "tagRef", "in": "path", "schema": { "type": "string", "description": "A tag, by ID or by name. Names match ignoring case and accents. When a value is one tag's ID and another's name, the ID wins." }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tag" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceLocked" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagNotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NameTaken" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Update tag", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagUpdate" } } }, "required": true } }, "delete": { "tags": ["Tags"], "operationId": "tags.delete", "parameters": [ { "name": "tagRef", "in": "path", "schema": { "type": "string", "description": "A tag, by ID or by name. Names match ignoring case and accents. When a value is one tag's ID and another's name, the ID wins." }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceLocked" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagNotFound" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "description": "Also removes it from every contact.", "summary": "Delete tag" } }, "/statuses": { "get": { "tags": ["Statuses"], "operationId": "statuses.list", "parameters": [], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusPage" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "List statuses" }, "post": { "tags": ["Statuses"], "operationId": "statuses.create", "parameters": [], "security": [ { "bearerAuth": [] } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceLocked" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NameTaken" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Create status", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusCreate" } } }, "required": true } } }, "/statuses/{statusRef}": { "get": { "tags": ["Statuses"], "operationId": "statuses.get", "parameters": [ { "name": "statusRef", "in": "path", "schema": { "type": "string", "description": "A status, by ID or by name. Names match ignoring case and accents. When a value is one status's ID and another's name, the ID wins." }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusNotFound" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Get status" }, "patch": { "tags": ["Statuses"], "operationId": "statuses.update", "parameters": [ { "name": "statusRef", "in": "path", "schema": { "type": "string", "description": "A status, by ID or by name. Names match ignoring case and accents. When a value is one status's ID and another's name, the ID wins." }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceLocked" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusNotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NameTaken" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Update status", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusUpdate" } } }, "required": true } }, "delete": { "tags": ["Statuses"], "operationId": "statuses.delete", "parameters": [ { "name": "statusRef", "in": "path", "schema": { "type": "string", "description": "A status, by ID or by name. Names match ignoring case and accents. When a value is one status's ID and another's name, the ID wins." }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceLocked" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusNotFound" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Delete status" } }, "/colors": { "get": { "tags": ["Colors"], "operationId": "colors.list", "parameters": [], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Color" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "List colors" } }, "/events": { "get": { "tags": ["Events"], "operationId": "events.list", "parameters": [ { "name": "afterSeq", "in": "query", "schema": { "type": "integer", "minimum": 0, "description": "Exclusive. A webhook's `seq` resumes right after it. Omit to start at the oldest retained event." }, "required": false }, { "name": "type", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "thread.created", "thread.deleted", "thread.assigned", "thread.unassigned", "thread.archived", "thread.unarchived", "thread.typing", "message.sent", "message.received", "message.edited", "message.deleted", "message.reactionAdded", "message.reactionRemoved", "contact.statusChanged", "contact.tagsChanged", "contact.notesChanged", "contact.valuationChanged", "contact.assigneeChanged", "tag.created", "tag.updated", "tag.deleted", "status.created", "status.updated", "status.deleted", "campaign.created", "campaign.started", "campaign.paused", "campaign.resumed", "campaign.completed", "target.contacted", "target.followUpSent", "target.replied", "connectionRequest.sent", "connectionRequest.accepted", "connectionRequest.withdrawn" ] }, "description": "Only these event types. Repeat the key to match any of several." }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Events to read, from 1 to 1000. Defaults to 100." }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventPage" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidRequest" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimited" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "description": "Reads events in sequence order. A page can hold fewer than `limit` events when some are filtered out; continue from `lastSeq` while `hasMore` is true.", "summary": "Replay events" } } }, "components": { "schemas": { "Unauthorized": { "type": "object", "properties": { "code": { "type": "string", "enum": ["unauthorized"] }, "message": { "type": "string" }, "details": { "type": "null" }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "RateLimited": { "type": "object", "properties": { "code": { "type": "string", "enum": ["rateLimited"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "window": { "type": "string", "enum": ["minute", "hour", "day"] }, "limit": { "type": "integer" }, "resetAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" } }, "required": ["window", "limit", "resetAt"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "Internal": { "type": "object", "properties": { "code": { "type": "string", "enum": ["internal"] }, "message": { "type": "string" }, "details": { "type": "null" }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "InvalidRequest": { "type": "object", "properties": { "code": { "type": "string", "enum": ["invalidRequest"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] } ] } }, "message": { "type": "string" } }, "required": ["path", "message"], "additionalProperties": false } } }, "required": ["issues"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "EventPage": { "type": "object", "properties": { "data": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ThreadCreatedEvent" }, { "$ref": "#/components/schemas/ThreadDeletedEvent" }, { "$ref": "#/components/schemas/ThreadAssignedEvent" }, { "$ref": "#/components/schemas/ThreadUnassignedEvent" }, { "$ref": "#/components/schemas/ThreadArchivedEvent" }, { "$ref": "#/components/schemas/ThreadUnarchivedEvent" }, { "$ref": "#/components/schemas/ThreadTypingEvent" }, { "$ref": "#/components/schemas/MessageSentEvent" }, { "$ref": "#/components/schemas/MessageReceivedEvent" }, { "$ref": "#/components/schemas/MessageEditedEvent" }, { "$ref": "#/components/schemas/MessageDeletedEvent" }, { "$ref": "#/components/schemas/MessageReactionAddedEvent" }, { "$ref": "#/components/schemas/MessageReactionRemovedEvent" }, { "$ref": "#/components/schemas/ContactStatusChangedEvent" }, { "$ref": "#/components/schemas/ContactTagsChangedEvent" }, { "$ref": "#/components/schemas/ContactNotesChangedEvent" }, { "$ref": "#/components/schemas/ContactValuationChangedEvent" }, { "$ref": "#/components/schemas/ContactAssigneeChangedEvent" }, { "$ref": "#/components/schemas/TagCreatedEvent" }, { "$ref": "#/components/schemas/TagUpdatedEvent" }, { "$ref": "#/components/schemas/TagDeletedEvent" }, { "$ref": "#/components/schemas/StatusCreatedEvent" }, { "$ref": "#/components/schemas/StatusUpdatedEvent" }, { "$ref": "#/components/schemas/StatusDeletedEvent" }, { "$ref": "#/components/schemas/CampaignCreatedEvent" }, { "$ref": "#/components/schemas/CampaignStartedEvent" }, { "$ref": "#/components/schemas/CampaignPausedEvent" }, { "$ref": "#/components/schemas/CampaignResumedEvent" }, { "$ref": "#/components/schemas/CampaignCompletedEvent" }, { "$ref": "#/components/schemas/TargetContactedEvent" }, { "$ref": "#/components/schemas/TargetFollowUpSentEvent" }, { "$ref": "#/components/schemas/TargetRepliedEvent" }, { "$ref": "#/components/schemas/ConnectionRequestSentEvent" }, { "$ref": "#/components/schemas/ConnectionRequestAcceptedEvent" }, { "$ref": "#/components/schemas/ConnectionRequestWithdrawnEvent" } ] } }, "lastSeq": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, { "type": "null" } ], "description": "The last sequence number read, including events this page leaves out. Null when nothing was read. Pass it as `afterSeq` to continue." }, "hasMore": { "type": "boolean" } }, "required": ["data", "lastSeq", "hasMore"], "additionalProperties": false }, "ConnectionRequestWithdrawnEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["connectionRequest.withdrawn"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["thread"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "not": { "type": "null" } } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "ConnectionRequestAcceptedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["connectionRequest.accepted"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["thread"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "not": { "type": "null" } } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "ConnectionRequestSentEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["connectionRequest.sent"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["thread"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "not": { "type": "null" } } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "TargetRepliedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["target.replied"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["campaign"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "type": "object", "properties": { "threadId": { "type": "string" }, "messageId": { "type": "string" }, "contactId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stepNumber": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, { "type": "null" } ] } }, "required": ["threadId", "messageId", "contactId", "stepNumber"], "additionalProperties": false } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "TargetFollowUpSentEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["target.followUpSent"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["campaign"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "type": "object", "properties": { "threadId": { "type": "string" }, "messageId": { "type": "string" }, "contactId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stepNumber": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, { "type": "null" } ] } }, "required": ["threadId", "messageId", "contactId", "stepNumber"], "additionalProperties": false } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "TargetContactedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["target.contacted"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["campaign"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "type": "object", "properties": { "threadId": { "type": "string" }, "messageId": { "type": "string" }, "contactId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stepNumber": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, { "type": "null" } ] } }, "required": ["threadId", "messageId", "contactId", "stepNumber"], "additionalProperties": false } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "CampaignCompletedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["campaign.completed"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["campaign"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "not": { "type": "null" } } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "CampaignResumedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["campaign.resumed"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["campaign"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "not": { "type": "null" } } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "CampaignPausedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["campaign.paused"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["campaign"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "not": { "type": "null" } } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "CampaignStartedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["campaign.started"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["campaign"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "not": { "type": "null" } } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "CampaignCreatedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["campaign.created"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["campaign"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "not": { "type": "null" } } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "StatusDeletedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["status.deleted"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["status"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "not": { "type": "null" } } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "StatusUpdatedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["status.updated"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["status"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "not": { "type": "null" } } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "StatusCreatedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["status.created"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["status"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "not": { "type": "null" } } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "TagDeletedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["tag.deleted"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["tag"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "not": { "type": "null" } } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "TagUpdatedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["tag.updated"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["tag"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "not": { "type": "null" } } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "TagCreatedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["tag.created"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["tag"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "not": { "type": "null" } } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "ContactAssigneeChangedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["contact.assigneeChanged"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["contact"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "type": "object", "properties": { "assigneeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": ["assigneeId"], "additionalProperties": false } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "ContactValuationChangedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["contact.valuationChanged"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["contact"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "type": "object", "properties": { "valuation": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, { "type": "null" } ] } }, "required": ["valuation"], "additionalProperties": false } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "ContactNotesChangedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["contact.notesChanged"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["contact"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "type": "object", "properties": { "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": ["notes"], "additionalProperties": false } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "ContactTagsChangedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["contact.tagsChanged"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["contact"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "type": "object", "properties": { "tagIds": { "type": "array", "items": { "type": "string" } } }, "required": ["tagIds"], "additionalProperties": false } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "ContactStatusChangedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["contact.statusChanged"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["contact"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "type": "object", "properties": { "statusId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": ["statusId"], "additionalProperties": false } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "MessageReactionRemovedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["message.reactionRemoved"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["message"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "type": "object", "properties": { "threadId": { "type": "string" }, "emoji": { "type": "string" }, "authorPlatformId": { "type": "string" } }, "required": ["threadId", "emoji", "authorPlatformId"], "additionalProperties": false } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "MessageReactionAddedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["message.reactionAdded"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["message"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "type": "object", "properties": { "threadId": { "type": "string" }, "emoji": { "type": "string" }, "authorPlatformId": { "type": "string" } }, "required": ["threadId", "emoji", "authorPlatformId"], "additionalProperties": false } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "MessageDeletedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["message.deleted"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["message"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "type": "object", "properties": { "threadId": { "type": "string" }, "scope": { "type": "string", "enum": ["self", "all"] } }, "required": ["threadId", "scope"], "additionalProperties": false } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "MessageEditedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["message.edited"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["message"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "type": "object", "properties": { "threadId": { "type": "string" } }, "required": ["threadId"], "additionalProperties": false } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "MessageReceivedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["message.received"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["message"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "type": "object", "properties": { "threadId": { "type": "string" } }, "required": ["threadId"], "additionalProperties": false } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "MessageSentEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["message.sent"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["message"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "type": "object", "properties": { "threadId": { "type": "string" } }, "required": ["threadId"], "additionalProperties": false } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "ThreadTypingEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["thread.typing"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["thread"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "not": { "type": "null" } } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "ThreadUnarchivedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["thread.unarchived"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["thread"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "not": { "type": "null" } } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "ThreadArchivedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["thread.archived"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["thread"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "not": { "type": "null" } } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "ThreadUnassignedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["thread.unassigned"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["thread"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "type": "object", "properties": { "assigneeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": ["assigneeId"], "additionalProperties": false } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "ThreadAssignedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["thread.assigned"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["thread"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "type": "object", "properties": { "assigneeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": ["assigneeId"], "additionalProperties": false } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "ThreadDeletedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["thread.deleted"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["thread"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "type": "object", "properties": { "accountLinkId": { "type": "string" }, "platform": { "$ref": "#/components/schemas/Platform" } }, "required": ["accountLinkId", "platform"], "additionalProperties": false } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "Platform": { "type": "string", "description": "The platform. Every team can use twitter, linkedin; a team may have others enabled.", "examples": ["twitter", "linkedin"] }, "ThreadCreatedEvent": { "type": "object", "properties": { "id": { "type": "string" }, "seq": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "type": { "type": "string", "enum": ["thread.created"] }, "apiVersion": { "type": "string", "enum": ["2"] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "object": { "type": "object", "properties": { "type": { "type": "string", "enum": ["thread"] }, "id": { "type": "string" }, "url": { "type": "string", "description": "The object's path under the API; 404 once it's deleted." } }, "required": ["type", "id", "url"], "additionalProperties": false }, "data": { "not": { "type": "null" } } }, "required": [ "id", "seq", "type", "apiVersion", "createdAt", "object", "data" ], "additionalProperties": false }, "Color": { "type": "object", "properties": { "name": { "type": "string", "examples": ["blue"] }, "hex": { "type": "string", "description": "A lowercase hex color.", "examples": ["#3b82f6"] } }, "required": ["name", "hex"], "additionalProperties": false, "description": "A color from Inboxapp's palette, for tags and statuses, which `GET /colors` lists." }, "WorkspaceLocked": { "type": "object", "properties": { "code": { "type": "string", "enum": ["workspaceLocked"] }, "message": { "type": "string" }, "details": { "type": "null" }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "StatusNotFound": { "type": "object", "properties": { "code": { "type": "string", "enum": ["statusNotFound"] }, "message": { "type": "string" }, "details": { "type": "null" }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "NameTaken": { "type": "object", "properties": { "code": { "type": "string", "enum": ["nameTaken"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "name": { "type": "string" } }, "required": ["name"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "Status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "description": "Unique within the team, ignoring case and accents." }, "color": { "anyOf": [ { "type": "string", "description": "A lowercase hex color.", "examples": ["#3b82f6"] }, { "type": "null" } ], "description": "Null when the status has no color." }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" } }, "required": ["id", "name", "color", "createdAt"], "additionalProperties": false, "description": "A pipeline stage on the team's board. A contact has at most one status." }, "StatusUpdate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "color": { "anyOf": [ { "type": "string", "minLength": 1, "description": "A color name from `GET /colors`, case-insensitive, or a 6-digit hex value. Stored as hex.", "examples": ["blue", "#3b82f6"] }, { "type": "null" } ], "description": "Null for no color." } }, "additionalProperties": false, "description": "Omitted fields are left unchanged, and `null` clears a nullable field." }, "StatusCreate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "color": { "anyOf": [ { "type": "string", "minLength": 1, "description": "A color name from `GET /colors`, case-insensitive, or a 6-digit hex value. Stored as hex.", "examples": ["blue", "#3b82f6"] }, { "type": "null" } ], "description": "Null for no color." } }, "required": ["name"], "additionalProperties": false }, "StatusPage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Status" } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass it back as `cursor`, with the same filters, to read the next page. Null on the last page." } }, "required": ["data", "nextCursor"], "additionalProperties": false, "description": "Every status, in board order, in one page." }, "TagNotFound": { "type": "object", "properties": { "code": { "type": "string", "enum": ["tagNotFound"] }, "message": { "type": "string" }, "details": { "type": "null" }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "Tag": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "description": "Unique within the team, ignoring case and accents." }, "color": { "type": "string", "description": "A lowercase hex color.", "examples": ["#3b82f6"] } }, "required": ["id", "name", "color"], "additionalProperties": false, "description": "A label the team puts on contacts. A contact can have several." }, "TagUpdate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "color": { "type": "string", "minLength": 1, "description": "A color name from `GET /colors`, case-insensitive, or a 6-digit hex value. Stored as hex.", "examples": ["blue", "#3b82f6"] } }, "additionalProperties": false, "description": "Omitted fields are left unchanged, and `null` clears a nullable field." }, "TagLimitReached": { "type": "object", "properties": { "code": { "type": "string", "enum": ["tagLimitReached"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "max": { "type": "integer" } }, "required": ["max"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "TagCreate": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "color": { "type": "string", "minLength": 1, "description": "A color name from `GET /colors`, case-insensitive, or a 6-digit hex value. Stored as hex.", "examples": ["blue", "#3b82f6"], "allOf": [ { "description": "Defaults to a random color from `GET /colors`." } ] } }, "required": ["name"], "additionalProperties": false }, "TagPage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass it back as `cursor`, with the same filters, to read the next page. Null on the last page." } }, "required": ["data", "nextCursor"], "additionalProperties": false, "description": "Every tag, ordered by `name`, in one page." }, "PlatformUnavailable": { "type": "object", "properties": { "code": { "type": "string", "enum": ["platformUnavailable"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "retryAfterSeconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": ["retryAfterSeconds"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "PlatformError": { "type": "object", "properties": { "code": { "type": "string", "enum": ["platformError"] }, "message": { "type": "string" }, "details": { "type": "null" }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "PlatformRateLimited": { "type": "object", "properties": { "code": { "type": "string", "enum": ["platformRateLimited"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "retryAfterSeconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": ["retryAfterSeconds"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "IntegrationSetupRequired": { "type": "object", "properties": { "code": { "type": "string", "enum": ["integrationSetupRequired"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "accountLinkId": { "type": "string" } }, "required": ["accountLinkId"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "AccountLinkDisconnected": { "type": "object", "properties": { "code": { "type": "string", "enum": ["accountLinkDisconnected"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "accountLinkId": { "type": "string" }, "status": { "type": "string", "enum": ["active", "offline", "paused"], "description": "`active` sends and syncs. `paused` is stopped for the reasons in `pauseReasons`, and resumes once none remain. `offline` lost its connection to the platform and must be reconnected in Inboxapp." } }, "required": ["accountLinkId", "status"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "CapabilityNotSupported": { "type": "object", "properties": { "code": { "type": "string", "enum": ["capabilityNotSupported"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "capability": { "type": "string", "enum": [ "message:send", "message:edit", "message:delete:self", "message:unsend", "message:react", "message:reply", "message:forward", "media:image", "media:video", "media:gif", "media:file", "media:audio", "thread:typing:send", "thread:typing:receive", "thread:message-requests", "thread:delete:remote", "directory:typeahead", "thread:archive:observe", "thread:archive:mutate", "thread:read:observe", "thread:read:mutate", "profile:follow", "profile:unfollow", "profile:connect", "profile:connect:note", "profile:resolve:id", "profile:resolve:username" ] } }, "required": ["capability"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "ConnectionRefused": { "type": "object", "properties": { "code": { "type": "string", "enum": ["connectionRefused"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "reason": { "type": "string", "enum": ["notAllowed", "noteTooLong", "noteAllowanceSpent"], "description": "`notAllowed` when the profile can't be invited right now, such as when already connected or invited. `noteAllowanceSpent` when the account has no notes left; send without one." } }, "required": ["reason"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "ProfileAmbiguous": { "type": "object", "properties": { "code": { "type": "string", "enum": ["profileAmbiguous"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "contactId": { "type": "string" }, "platform": { "$ref": "#/components/schemas/Platform" } }, "required": ["contactId", "platform"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "PlatformNotSupported": { "type": "object", "properties": { "code": { "type": "string", "enum": ["platformNotSupported"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "platform": { "$ref": "#/components/schemas/Platform" }, "supported": { "type": "array", "items": { "$ref": "#/components/schemas/Platform" } } }, "required": ["platform", "supported"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "RecipientUnavailable": { "type": "object", "properties": { "code": { "type": "string", "enum": ["recipientUnavailable"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "reason": { "type": "string" } }, "required": ["reason"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "PlanRequired": { "type": "object", "properties": { "code": { "type": "string", "enum": ["planRequired"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "feature": { "type": "string" } }, "required": ["feature"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "PlatformNotAvailable": { "type": "object", "properties": { "code": { "type": "string", "enum": ["platformNotAvailable"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "platform": { "$ref": "#/components/schemas/Platform" } }, "required": ["platform"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "AccountLinkNotFound": { "type": "object", "properties": { "code": { "type": "string", "enum": ["accountLinkNotFound"] }, "message": { "type": "string" }, "details": { "type": "null" }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "ContactNotFound": { "type": "object", "properties": { "code": { "type": "string", "enum": ["contactNotFound"] }, "message": { "type": "string" }, "details": { "type": "null" }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "ThreadNotFound": { "type": "object", "properties": { "code": { "type": "string", "enum": ["threadNotFound"] }, "message": { "type": "string" }, "details": { "type": "null" }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "ConnectionRequest": { "type": "object", "properties": { "accountLinkId": { "type": "string" }, "profileId": { "type": "string" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": ["accountLinkId", "profileId", "note"], "additionalProperties": false, "description": "A connection request the platform accepted for delivery." }, "ConnectionRequestCreate": { "type": "object", "properties": { "target": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": ["thread"] }, "threadId": { "$ref": "#/components/schemas/Cuid2" } }, "required": ["type", "threadId"], "additionalProperties": false, "title": "Thread", "description": "The profile of an existing one-to-one thread, from the thread's account link." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["contact"] }, "accountLinkId": { "allOf": [ { "$ref": "#/components/schemas/Cuid2" }, { "description": "The account link to send the request from." } ] }, "contactId": { "$ref": "#/components/schemas/Cuid2" } }, "required": ["type", "accountLinkId", "contactId"], "additionalProperties": false, "title": "Contact", "description": "The contact's profile on the account link's platform. Fails with `recipientUnavailable` when the contact has none there, and `profileAmbiguous` when it has several." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["profile"] }, "accountLinkId": { "allOf": [ { "$ref": "#/components/schemas/Cuid2" }, { "description": "The account link to send the request from." } ] }, "platform": { "allOf": [ { "$ref": "#/components/schemas/Platform" }, { "description": "Must be the account link's platform." } ] }, "platformId": { "type": "string", "minLength": 1, "description": "The person's ID on the platform. Reaching someone Inboxapp hasn't stored needs the account link's `profile:resolve:id`." } }, "required": ["type", "accountLinkId", "platform", "platformId"], "additionalProperties": false, "title": "Profile by platform ID", "description": "A platform user. Without the Advanced API add-on, the profile must already belong to one of the team's contacts." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["profile"] }, "accountLinkId": { "allOf": [ { "$ref": "#/components/schemas/Cuid2" }, { "description": "The account link to send the request from." } ] }, "platform": { "allOf": [ { "$ref": "#/components/schemas/Platform" }, { "description": "Must be the account link's platform." } ] }, "username": { "type": "string", "minLength": 1, "description": "The person's username on the platform, without a display prefix such as `@`. On LinkedIn, what follows `/in/` in their profile URL: the vanity name or the `ACoA…` profile ID. Reaching someone Inboxapp hasn't stored needs the account link's `profile:resolve:username`.", "examples": ["jane", "ACoAABcdEfGh1234567890"] } }, "required": ["type", "accountLinkId", "platform", "username"], "additionalProperties": false, "title": "Profile by username", "description": "A platform user. Without the Advanced API add-on, the profile must already belong to one of the team's contacts." } ] }, "note": { "type": "string", "minLength": 1, "allOf": [ { "description": "Up to the platform's `limits.connectNoteCharacters`. Needs `profile:connect:note`, and fails with `connectionRefused` once the account has no notes left." } ] } }, "required": ["target"], "additionalProperties": false }, "Cuid2": { "type": "string", "pattern": "^[0-9a-z]+$" }, "MessageNotFound": { "type": "object", "properties": { "code": { "type": "string", "enum": ["messageNotFound"] }, "message": { "type": "string" }, "details": { "type": "null" }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "AttachmentMedia": { "type": "object", "properties": { "index": { "type": "integer", "description": "The attachment's stable position in `attachments`, which `GET /messages/{messageId}/attachments/{index}` takes." }, "kind": { "type": "string", "enum": ["image", "gif", "video", "audio", "file"] }, "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contentType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "examples": ["image/jpeg"] }, "sizeBytes": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, { "type": "null" } ] }, "width": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, { "type": "null" } ] }, "height": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, { "type": "null" } ] }, "aspectRatio": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, { "type": "null" } ], "description": "Width divided by height." }, "durationSeconds": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, { "type": "null" } ], "description": "Video and audio only." }, "status": { "type": "string", "enum": ["ready", "pending", "processing", "failed"], "description": "`ready` once `url` is usable. `pending` and `processing` while Inboxapp stores a copy: resolve the attachment again later. `failed` when Inboxapp gave up." }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Set exactly when `status` is `ready`." }, "expiresAt": { "anyOf": [ { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, { "type": "null" } ], "description": "When `url` stops working. Null for URLs that don't expire. Get a fresh URL from `GET /messages/{messageId}/attachments/{index}`." }, "poster": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "expiresAt": { "anyOf": [ { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, { "type": "null" } ], "description": "When `url` stops working. Null for URLs that don't expire. Get a fresh URL from `GET /messages/{messageId}/attachments/{index}`." }, "width": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, { "type": "null" } ] }, "height": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, { "type": "null" } ] } }, "required": ["url", "expiresAt", "width", "height"], "additionalProperties": false }, { "type": "null" } ], "description": "The still frame shown before a video plays. Video only, and only once usable." } }, "required": [ "index", "kind", "filename", "contentType", "sizeBytes", "width", "height", "aspectRatio", "durationSeconds", "status", "url", "expiresAt", "poster" ], "additionalProperties": false, "description": "An image, GIF, video, audio clip or file. Its `url` expires, so fetch it again when needed." }, "ContentRejected": { "type": "object", "properties": { "code": { "type": "string", "enum": ["contentRejected"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "detail": { "type": "string" } }, "required": ["detail"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "MessageNotModifiable": { "type": "object", "properties": { "code": { "type": "string", "enum": ["messageNotModifiable"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "reason": { "type": "string" } }, "required": ["reason"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "MutationWindowClosed": { "type": "object", "properties": { "code": { "type": "string", "enum": ["mutationWindowClosed"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "capability": { "type": "string", "enum": [ "message:send", "message:edit", "message:delete:self", "message:unsend", "message:react", "message:reply", "message:forward", "media:image", "media:video", "media:gif", "media:file", "media:audio", "thread:typing:send", "thread:typing:receive", "thread:message-requests", "thread:delete:remote", "directory:typeahead", "thread:archive:observe", "thread:archive:mutate", "thread:read:observe", "thread:read:mutate", "profile:follow", "profile:unfollow", "profile:connect", "profile:connect:note", "profile:resolve:id", "profile:resolve:username" ] }, "closedAt": { "anyOf": [ { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, { "type": "null" } ] } }, "required": ["capability", "closedAt"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "ThreadRestricted": { "type": "object", "properties": { "code": { "type": "string", "enum": ["threadRestricted"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "capability": { "type": "string", "enum": [ "message:send", "message:edit", "message:delete:self", "message:unsend", "message:react", "message:reply", "message:forward", "media:image", "media:video", "media:gif", "media:file", "media:audio", "thread:typing:send", "thread:typing:receive", "thread:message-requests", "thread:delete:remote", "directory:typeahead", "thread:archive:observe", "thread:archive:mutate", "thread:read:observe", "thread:read:mutate", "profile:follow", "profile:unfollow", "profile:connect", "profile:connect:note", "profile:resolve:id", "profile:resolve:username" ] } }, "required": ["capability"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "Reactions": { "type": "object", "properties": { "reactions": { "type": "array", "items": { "$ref": "#/components/schemas/Reaction" } }, "version": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] } }, "required": ["reactions", "version"], "additionalProperties": false }, "Reaction": { "type": "object", "properties": { "emoji": { "type": "string" }, "author": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": ["accountLink"] }, "accountLinkId": { "type": "string", "description": "An account link: a platform account the team connected to Inboxapp, the team's side of a conversation." }, "accountLink": { "$ref": "#/components/schemas/AccountLink" } }, "required": ["type", "accountLinkId"], "additionalProperties": false, "title": "Account link", "description": "The team's account link reacted." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["profile"] }, "profileId": { "type": "string", "description": "A profile: one person's account on one platform. Not a contact ID." }, "contactId": { "anyOf": [ { "type": "string", "description": "A contact: the team's record of the person, with their status, tags, notes, valuation and default assignee." }, { "type": "null" } ], "description": "Null when the profile has no contact in the team." }, "profile": { "$ref": "#/components/schemas/Profile" }, "contact": { "$ref": "#/components/schemas/Contact" } }, "required": ["type", "profileId", "contactId"], "additionalProperties": false, "title": "Profile", "description": "The other side of the conversation reacted." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["unknown"] }, "platformId": { "type": "string", "description": "The ID the platform gives this object. Only meaningful next to its `platform`." } }, "required": ["type", "platformId"], "additionalProperties": false, "title": "Unknown", "description": "Someone Inboxapp can't match to the account link or the thread's profile, such as another member of a group conversation. Expands to nothing." } ] }, "createdAt": { "anyOf": [ { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, { "type": "null" } ], "description": "Null when the platform reports no time." } }, "required": ["emoji", "author", "createdAt"], "additionalProperties": false }, "Contact": { "type": "object", "properties": { "id": { "type": "string" }, "profiles": { "type": "array", "items": { "$ref": "#/components/schemas/Profile" }, "description": "The person's profiles, oldest link first. Profiles on platforms unavailable to the team are left out." }, "statusId": { "anyOf": [ { "type": "string", "description": "A status: a pipeline stage on the team's board." }, { "type": "null" } ] }, "tagIds": { "type": "array", "items": { "type": "string", "description": "A tag: a label the team puts on contacts." } }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "valuation": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, { "type": "null" } ], "description": "What the person is worth to the team, in the team's `currency`." }, "assigneeId": { "anyOf": [ { "type": "string", "description": "A member: a person on the team." }, { "type": "null" } ], "description": "The default assignee of this contact's threads that have none of their own." }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "updatedAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "status": { "$ref": "#/components/schemas/Status" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "assignee": { "$ref": "#/components/schemas/Member" } }, "required": [ "id", "profiles", "statusId", "tagIds", "notes", "valuation", "assigneeId", "createdAt", "updatedAt" ], "additionalProperties": false, "description": "The team's record of a person: their profiles, plus the team's CRM state about them." }, "Member": { "type": "object", "properties": { "id": { "type": "string", "description": "The member ID that `assigneeId` fields take." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "type": "string" }, "imageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "role": { "type": "string", "enum": ["owner", "admin", "user"], "description": "`owner` and `admin` manage the team. A `user` can't change settings, billing or members." }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" } }, "required": ["id", "name", "email", "imageUrl", "role", "createdAt"], "additionalProperties": false, "description": "A person on the team, who can be assigned threads and contacts." }, "Profile": { "type": "object", "properties": { "id": { "type": "string" }, "platform": { "$ref": "#/components/schemas/Platform" }, "platformId": { "type": "string", "description": "The ID the platform gives this object. Only meaningful next to its `platform`." }, "username": { "type": "string", "description": "The platform username, without a display prefix such as `@`.", "examples": ["jane"] }, "handle": { "type": "string", "description": "The username as the platform displays it. Show this, and look up by `username`.", "examples": ["@jane"] }, "displayName": { "type": "string" }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "websiteDomain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "verified": { "type": "boolean", "description": "The platform vouches for the account, such as with an X badge. Platform-specific badges are in `platformData`." }, "isOrganization": { "type": "boolean", "description": "A company or page rather than a person." }, "isProtected": { "type": "boolean", "description": "The account's posts are visible only to approved followers." }, "followerCount": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, { "type": "null" } ] }, "followingCount": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, { "type": "null" } ] }, "postCount": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, { "type": "null" } ] }, "engagementCount": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, { "type": "null" } ], "description": "On X, how many posts the user has liked." }, "listedCount": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, { "type": "null" } ], "description": "On X, how many lists include the profile." }, "accountStatus": { "type": "string", "enum": ["active", "suspended", "notFound"], "description": "`suspended` by the platform, or `notFound` when deleted or deactivated." }, "platformCreatedAt": { "anyOf": [ { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, { "type": "null" } ], "description": "When the account was created on the platform." }, "profileUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "updatedAt": { "type": "string", "description": "When Inboxapp last stored a change to this profile.", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "platformData": { "$ref": "#/components/schemas/ProfilePlatformData" }, "relationships": { "type": "array", "items": { "$ref": "#/components/schemas/Relationship" }, "description": "One entry per team account link that has interacted with the profile." } }, "required": [ "id", "platform", "platformId", "username", "handle", "displayName", "avatarUrl", "bio", "location", "websiteUrl", "websiteDomain", "verified", "isOrganization", "isProtected", "followerCount", "followingCount", "postCount", "engagementCount", "listedCount", "accountStatus", "platformCreatedAt", "profileUrl", "updatedAt", "platformData", "relationships" ], "additionalProperties": false, "description": "One person's account on one platform. Profile data is shared across teams; the team's own data about the person is on their contact." }, "Relationship": { "type": "object", "properties": { "accountLinkId": { "type": "string" }, "degree": { "anyOf": [ { "type": "string", "enum": ["self", "first", "second", "third", "outOfNetwork"] }, { "type": "null" } ], "description": "How close the profile is to the account link on the platform's network, as last observed. `null` when never observed." }, "connectionRequest": { "anyOf": [ { "type": "object", "properties": { "sentAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" } }, "required": ["sentAt"], "additionalProperties": false }, { "type": "null" } ], "description": "The account link's pending connection request. `null` once the profile is seen accepting it or the request is withdrawn, or when none was sent." } }, "required": ["accountLinkId", "degree", "connectionRequest"], "additionalProperties": false, "description": "What one of the team's account links knows about a profile." }, "ProfilePlatformData": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": ["twitter"] }, "badge": { "anyOf": [ { "type": "string", "enum": ["blue", "gold", "gray"] }, { "type": "null" } ] }, "profileType": { "type": "string", "enum": ["personal", "business", "government"] }, "professionalCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "urlEntities": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "expandedUrl": { "type": "string" }, "displayUrl": { "type": "string" }, "indices": { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ], "maxItems": 2, "minItems": 2 } }, "required": ["url", "expandedUrl", "displayUrl", "indices"], "additionalProperties": false } }, "bannerUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rawData": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "_tag", "badge", "profileType", "professionalCategory", "urlEntities", "bannerUrl", "rawData" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": ["linkedin"] }, "profileUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "kind": { "anyOf": [ { "type": "string", "enum": ["member", "organization"] }, { "type": "null" } ] }, "memberBadge": { "anyOf": [ { "type": "string", "enum": ["premium", "verified"] }, { "type": "null" } ] }, "bannerUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bannerSize": { "anyOf": [ { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" } }, "required": ["width", "height"], "additionalProperties": false }, { "type": "null" } ] }, "hydratedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "imageAssetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "connectionsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "currentRole": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currentRoleStart": { "anyOf": [ { "type": "object", "properties": { "year": { "type": "number" }, "month": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": ["year", "month"], "additionalProperties": false }, { "type": "null" } ] }, "currentCompanyName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currentCompanyUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "topSchoolName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "topSchoolUrn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "topSchoolDegree": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "topSchoolPeriod": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "employeeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "employeeCountRange": { "anyOf": [ { "type": "object", "properties": { "start": { "type": "number" }, "end": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": ["start", "end"], "additionalProperties": false }, { "type": "null" } ] }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pageKind": { "anyOf": [ { "type": "string", "enum": ["company", "school", "showcase"] }, { "type": "null" } ] }, "currentCompanyLogoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "topSchoolLogoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": ["_tag"], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string" } }, "required": ["_tag"], "description": "A platform the team has enabled beyond those every team can use. Its fields are not listed here." } ], "description": "Fields only one platform has, tagged by `_tag`. Ignore tags you don't know." }, "AccountLink": { "type": "object", "properties": { "id": { "type": "string" }, "platform": { "$ref": "#/components/schemas/Platform" }, "platformId": { "type": "string", "description": "The ID the platform gives this object. Only meaningful next to its `platform`." }, "username": { "anyOf": [ { "type": "string", "description": "The platform username, without a display prefix such as `@`.", "examples": ["jane"] }, { "type": "null" } ] }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": ["active", "offline", "paused"], "description": "`active` sends and syncs. `paused` is stopped for the reasons in `pauseReasons`, and resumes once none remain. `offline` lost its connection to the platform and must be reconnected in Inboxapp." }, "pauseReasons": { "type": "array", "items": { "type": "string" }, "description": "Why the account link is paused. New reasons may be added.", "examples": [["billing"], ["no-xchat"]] }, "capabilities": { "type": "array", "items": { "type": "string", "enum": [ "message:send", "message:edit", "message:delete:self", "message:unsend", "message:react", "message:reply", "message:forward", "media:image", "media:video", "media:gif", "media:file", "media:audio", "thread:typing:send", "thread:typing:receive", "thread:message-requests", "thread:delete:remote", "directory:typeahead", "thread:archive:observe", "thread:archive:mutate", "thread:read:observe", "thread:read:mutate", "profile:follow", "profile:unfollow", "profile:connect", "profile:connect:note", "profile:resolve:id", "profile:resolve:username" ] }, "description": "What this account can do: its platform's capabilities, narrowed for this account. An operation it lacks fails with `capabilityNotSupported`." }, "syncedAt": { "anyOf": [ { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, { "type": "null" } ], "description": "When Inboxapp finished importing the account's conversations. Null until then." }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" } }, "required": [ "id", "platform", "platformId", "username", "displayName", "avatarUrl", "status", "pauseReasons", "capabilities", "syncedAt", "createdAt" ], "additionalProperties": false, "description": "A platform account the team connected to Inboxapp. Every conversation and message goes through one." }, "ReactionChange": { "type": "object", "properties": { "emoji": { "type": "string", "pattern": "^(?:\\p{Regional_Indicator}{2}|[#*0-9]\\uFE0F?\\u20E3|\\u{1F3F4}[\\u{E0020}-\\u{E007E}]+\\u{E007F}|\\p{Extended_Pictographic}\\uFE0F?\\p{Emoji_Modifier}?(?:\\u200D\\p{Extended_Pictographic}\\uFE0F?\\p{Emoji_Modifier}?)*)(?![\\s\\S])", "description": "Exactly one emoji.", "examples": ["👍"] } }, "required": ["emoji"], "additionalProperties": false }, "MessageHistory": { "type": "object", "properties": { "versions": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string" }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "origin": { "anyOf": [ { "type": "string", "enum": ["inbox", "platform", "api"] }, { "type": "null" } ], "description": "Where the change was made: `inbox` in the app, `api` through this API, `platform` directly on the platform. Null on older records." } }, "required": ["content", "createdAt", "origin"], "additionalProperties": false }, "description": "The original first, at the message's `createdAt`, then each edit." }, "deletion": { "anyOf": [ { "type": "object", "properties": { "deletedAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "scope": { "type": "string", "enum": ["self", "all"], "description": "`self` deletes for the account link only, which needs `message:delete:self`. `all` unsends for every participant, which needs `message:unsend`." }, "origin": { "anyOf": [ { "type": "string", "enum": ["inbox", "platform", "api"] }, { "type": "null" } ], "description": "Where the change was made: `inbox` in the app, `api` through this API, `platform` directly on the platform. Null on older records." } }, "required": ["deletedAt", "scope", "origin"], "additionalProperties": false }, { "type": "null" } ], "description": "Null while the message isn't deleted." }, "times": { "type": "string", "enum": ["platform", "observed"], "description": "Whether edit and deletion times come from the platform, or are when Inboxapp noticed the change." } }, "required": ["versions", "deletion", "times"], "additionalProperties": false }, "MessageDeletion": { "type": "object", "properties": { "messageId": { "type": "string" }, "scope": { "type": "string", "enum": ["self", "all"], "description": "`self` deletes for the account link only, which needs `message:delete:self`. `all` unsends for every participant, which needs `message:unsend`." }, "deletedAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" } }, "required": ["messageId", "scope", "deletedAt"], "additionalProperties": false }, "Message": { "type": "object", "properties": { "id": { "type": "string" }, "threadId": { "type": "string", "description": "A thread: a conversation between one of the team's account links and one profile." }, "accountLinkId": { "type": "string", "description": "An account link: a platform account the team connected to Inboxapp, the team's side of a conversation." }, "platform": { "$ref": "#/components/schemas/Platform" }, "platformId": { "anyOf": [ { "type": "string", "description": "The ID the platform gives this object. Only meaningful next to its `platform`." }, { "type": "null" } ], "description": "Null when the platform assigned none." }, "direction": { "type": "string", "enum": ["inbound", "outbound"], "description": "`inbound` was received from the other side. `outbound` was sent by the account link." }, "sentBy": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": ["member"] }, "memberId": { "type": "string", "description": "A member: a person on the team." }, "member": { "$ref": "#/components/schemas/Member" } }, "required": ["type", "memberId"], "additionalProperties": false, "title": "Member", "description": "A team member sent it from Inboxapp." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["agent"] }, "agentId": { "type": "string" }, "memberId": { "type": "string", "description": "A member: a person on the team." }, "agent": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, "member": { "$ref": "#/components/schemas/Member" } }, "required": ["type", "agentId", "memberId"], "additionalProperties": false, "title": "Agent", "description": "An agent the member authorized sent it, such as an MCP client. It acts with the member's access." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["campaign"] }, "campaignId": { "type": "string" }, "stepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The sequence step that sent it, possibly since removed. Null when no step was recorded. Not expandable." } }, "required": ["type", "campaignId", "stepId"], "additionalProperties": false, "title": "Campaign", "description": "A campaign sent it." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["api"] }, "tokenId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "token": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "required": ["type", "tokenId"], "additionalProperties": false, "title": "API token", "description": "An API token sent it. `tokenId` is null on messages sent before tokens were recorded, and `token` is absent once the token is deleted." } ] }, { "type": "null" } ], "description": "Who on the team sent an outbound message. Null for inbound messages and for messages sent outside Inboxapp." }, "content": { "type": "string", "description": "The text as Inboxapp last saw it. A deleted message keeps its content." }, "entities": { "$ref": "#/components/schemas/MessageEntities" }, "attachments": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/AttachmentMedia" }, { "$ref": "#/components/schemas/AttachmentCard" } ] }, "description": "Media, and at most one link card, told apart by `kind`." }, "forwarded": { "anyOf": [ { "type": "object", "properties": { "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": ["content"], "additionalProperties": false }, { "type": "null" } ], "description": "Set when the message forwards another one, with the forwarded text as the sender's app declared it. Null otherwise." }, "reactions": { "type": "array", "items": { "$ref": "#/components/schemas/Reaction" } }, "editedAt": { "anyOf": [ { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, { "type": "null" } ], "description": "When the message was last edited. Null when it hasn't been, or when the edit time wasn't recorded. Every version is in `GET /messages/{messageId}/history`." }, "deletedAt": { "anyOf": [ { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, { "type": "null" } ], "description": "Set once the message was deleted for the account link or unsent for everyone. Deleted messages stay in lists, and `GET /messages/{messageId}/history` has the scope." }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "platformData": { "$ref": "#/components/schemas/MessagePlatformData" }, "replyTo": { "anyOf": [ { "type": "object", "properties": { "messageId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Null when Inboxapp has no copy of the quoted message in this thread." }, "platformId": { "anyOf": [ { "type": "string", "description": "The ID the platform gives this object. Only meaningful next to its `platform`." }, { "type": "null" } ] }, "content": { "type": "string", "description": "The quoted text as captured at reply time." }, "authorName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The quoted sender's display name, from the platform." }, "message": { "$ref": "#/components/schemas/Message" } }, "required": [ "messageId", "platformId", "content", "authorName" ], "additionalProperties": false }, { "type": "null" } ], "description": "The message this one replies to. Null when it isn't a reply." }, "thread": { "$ref": "#/components/schemas/Thread" }, "accountLink": { "$ref": "#/components/schemas/AccountLink" } }, "required": [ "id", "threadId", "accountLinkId", "platform", "platformId", "direction", "sentBy", "content", "entities", "attachments", "forwarded", "reactions", "editedAt", "deletedAt", "createdAt", "platformData", "replyTo" ], "additionalProperties": false, "description": "A message in a thread, sent or received by its account link." }, "Thread": { "type": "object", "properties": { "id": { "type": "string" }, "platform": { "allOf": [ { "$ref": "#/components/schemas/Platform" }, { "description": "Always the platform of the thread's account link and profile." } ] }, "platformId": { "anyOf": [ { "type": "string", "description": "The ID the platform gives this object. Only meaningful next to its `platform`." }, { "type": "null" } ], "description": "The conversation's ID on the platform. Null until the first message creates the conversation there." }, "accountLinkId": { "type": "string", "description": "An account link: a platform account the team connected to Inboxapp, the team's side of a conversation." }, "profileId": { "type": "string", "description": "A profile: one person's account on one platform. Not a contact ID." }, "contactId": { "type": "string", "description": "A contact: the team's record of the person, with their status, tags, notes, valuation and default assignee." }, "assigneeId": { "anyOf": [ { "type": "string", "description": "A member: a person on the team." }, { "type": "null" } ], "description": "The thread's own assignee, else its contact's default." }, "isRequest": { "type": "boolean", "description": "True while the conversation is an incoming request the account hasn't replied to or accepted. Requests are in the `requests` folder, not `inbox`." }, "acceptanceState": { "type": "string", "enum": ["required", "notRequired", "unknown"], "description": "Whether the platform needs the account to accept the conversation before replying normally. `unknown` when the platform doesn't say. Independent of `isRequest`." }, "archived": { "type": "boolean" }, "unread": { "type": "boolean", "description": "Marked unread in Inboxapp for the team owner, whose view the API takes. A thread no one has opened yet is not unread." }, "restrictions": { "type": "array", "items": { "type": "string", "enum": [ "message:send", "message:edit", "message:delete:self", "message:unsend", "message:react", "message:reply", "message:forward", "media:image", "media:video", "media:gif", "media:file", "media:audio", "thread:typing:send", "thread:typing:receive", "thread:message-requests", "thread:delete:remote", "directory:typeahead", "thread:archive:observe", "thread:archive:mutate", "thread:read:observe", "thread:read:mutate", "profile:follow", "profile:unfollow", "profile:connect", "profile:connect:note", "profile:resolve:id", "profile:resolve:username" ] }, "description": "Capabilities the platform disables in this conversation, on top of the account link's `capabilities`. Using one fails with `threadRestricted`." }, "syncing": { "type": "boolean", "description": "True while Inboxapp imports the conversation's older messages, so the message list may be incomplete." }, "typingIndicators": { "type": "string", "enum": ["enabled", "disabled", "teamDefault"], "description": "Whether Inboxapp sends typing indicators to the platform while someone composes in this thread. `teamDefault` follows the team's setting." }, "lastMessage": { "anyOf": [ { "$ref": "#/components/schemas/LastMessage" }, { "type": "null" } ] }, "activity": { "anyOf": [ { "$ref": "#/components/schemas/ThreadActivity" }, { "type": "null" } ] }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" }, "accountLink": { "$ref": "#/components/schemas/AccountLink" }, "profile": { "$ref": "#/components/schemas/Profile" }, "contact": { "$ref": "#/components/schemas/Contact" }, "assignee": { "$ref": "#/components/schemas/Member" } }, "required": [ "id", "platform", "platformId", "accountLinkId", "profileId", "contactId", "assigneeId", "isRequest", "acceptanceState", "archived", "unread", "restrictions", "syncing", "typingIndicators", "lastMessage", "activity", "createdAt" ], "additionalProperties": false, "description": "A conversation between one of the team's account links and one profile." }, "ThreadActivity": { "type": "object", "properties": { "preview": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "One line as the inbox shows it, such as the message text or `You reacted with 👍`. Null when there is nothing to show." }, "direction": { "type": "string", "enum": ["inbound", "outbound"], "description": "`outbound` when the account link acted." }, "at": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" } }, "required": ["preview", "direction", "at"], "additionalProperties": false, "description": "The thread's latest activity: a message, or a reaction since. `at` is when it happened, which is not always the thread's position in a list: see `order`." }, "LastMessage": { "type": "object", "properties": { "id": { "type": "string" }, "direction": { "type": "string", "enum": ["inbound", "outbound"], "description": "`inbound` was received from the other side. `outbound` was sent by the account link." }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" } }, "required": ["id", "direction", "createdAt"], "additionalProperties": false, "description": "The thread's latest message. Get it for its content." }, "MessagePlatformData": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": ["twitter"] }, "encrypted": { "type": "boolean", "description": "An end-to-end encrypted X Chat message." } }, "required": ["_tag", "encrypted"], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": ["linkedin"] } }, "required": ["_tag"], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string" } }, "required": ["_tag"], "description": "A platform the team has enabled beyond those every team can use. Its fields are not listed here." } ], "description": "Fields only one platform has, tagged by `_tag`. Ignore tags you don't know." }, "AttachmentCard": { "type": "object", "properties": { "index": { "type": "integer", "description": "The attachment's stable position in `attachments`, which `GET /messages/{messageId}/attachments/{index}` takes." }, "kind": { "type": "string", "enum": ["card"] }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnail": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "width": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "height": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "alt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": ["url", "width", "height", "alt"], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "index", "kind", "url", "title", "description", "domain", "thumbnail" ], "additionalProperties": false, "description": "The preview of a link in the message. A message has at most one." }, "MessageEntities": { "type": "object", "properties": { "urls": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "displayUrl": { "type": "string" }, "indices": { "anyOf": [ { "type": "object", "properties": { "start": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "end": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] } }, "required": ["start", "end"], "additionalProperties": false, "description": "Offsets into `content` in Unicode code points, end-exclusive. A JavaScript client slices `Array.from(content)`, not `content`." }, { "type": "null" } ], "description": "Null when the platform gave no position." } }, "required": ["url", "displayUrl", "indices"], "additionalProperties": false } }, "postShares": { "type": "array", "items": { "type": "object", "properties": { "platformId": { "type": "string", "description": "The ID the platform gives this object. Only meaningful next to its `platform`." }, "url": { "type": "string" }, "indices": { "anyOf": [ { "type": "object", "properties": { "start": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "end": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] } }, "required": ["start", "end"], "additionalProperties": false, "description": "Offsets into `content` in Unicode code points, end-exclusive. A JavaScript client slices `Array.from(content)`, not `content`." }, { "type": "null" } ], "description": "Null when the platform gave no position." } }, "required": ["platformId", "url", "indices"], "additionalProperties": false }, "description": "Platform posts shared in the message, such as a quoted post." }, "mentions": { "type": "array", "items": { "type": "object", "properties": { "username": { "type": "string", "description": "The platform username, without a display prefix such as `@`.", "examples": ["jane"] }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformId": { "anyOf": [ { "type": "string", "description": "The ID the platform gives this object. Only meaningful next to its `platform`." }, { "type": "null" } ] }, "indices": { "anyOf": [ { "type": "object", "properties": { "start": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "end": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] } }, "required": ["start", "end"], "additionalProperties": false, "description": "Offsets into `content` in Unicode code points, end-exclusive. A JavaScript client slices `Array.from(content)`, not `content`." }, { "type": "null" } ], "description": "Null when the platform gave no position." } }, "required": ["username", "displayName", "platformId", "indices"], "additionalProperties": false } }, "hashtags": { "type": "array", "items": { "type": "object", "properties": { "tag": { "type": "string" }, "indices": { "anyOf": [ { "type": "object", "properties": { "start": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "end": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] } }, "required": ["start", "end"], "additionalProperties": false, "description": "Offsets into `content` in Unicode code points, end-exclusive. A JavaScript client slices `Array.from(content)`, not `content`." }, { "type": "null" } ], "description": "Null when the platform gave no position." } }, "required": ["tag", "indices"], "additionalProperties": false } }, "cashtags": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string" }, "indices": { "anyOf": [ { "type": "object", "properties": { "start": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "end": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] } }, "required": ["start", "end"], "additionalProperties": false, "description": "Offsets into `content` in Unicode code points, end-exclusive. A JavaScript client slices `Array.from(content)`, not `content`." }, { "type": "null" } ], "description": "Null when the platform gave no position." } }, "required": ["symbol", "indices"], "additionalProperties": false } }, "format": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": ["bold", "list", "orderedList", "listItem"] }, "indices": { "type": "object", "properties": { "start": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] }, "end": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": ["Infinity", "-Infinity", "NaN"] } ] } }, "required": ["start", "end"], "additionalProperties": false, "description": "Offsets into `content` in Unicode code points, end-exclusive. A JavaScript client slices `Array.from(content)`, not `content`." } }, "required": ["kind", "indices"], "additionalProperties": false }, "description": "Rich-text formatting. A `list` or `orderedList` spans its `listItem`s." } }, "required": [ "urls", "postShares", "mentions", "hashtags", "cashtags", "format" ], "additionalProperties": false, "description": "Parts of `content` the platform marked up." }, "MessageEdit": { "type": "object", "properties": { "content": { "type": "string", "minLength": 1 } }, "required": ["content"], "additionalProperties": false }, "SendUnconfirmed": { "type": "object", "properties": { "code": { "type": "string", "enum": ["sendUnconfirmed"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "messageId": { "type": "string" } }, "required": ["messageId"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "IdempotencyKeyReused": { "type": "object", "properties": { "code": { "type": "string", "enum": ["idempotencyKeyReused"] }, "message": { "type": "string" }, "details": { "type": "null" }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "SendInProgress": { "type": "object", "properties": { "code": { "type": "string", "enum": ["sendInProgress"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "messageId": { "type": "string" } }, "required": ["messageId"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "SendResult": { "type": "object", "properties": { "message": { "$ref": "#/components/schemas/Message" }, "thread": { "allOf": [ { "$ref": "#/components/schemas/Thread" }, { "description": "The thread the message landed in, which a concurrent send may have created. Adopt it." } ] } }, "required": ["message", "thread"], "additionalProperties": false }, "SendRequest": { "type": "object", "properties": { "target": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": ["thread"] }, "threadId": { "$ref": "#/components/schemas/Cuid2" } }, "required": ["type", "threadId"], "additionalProperties": false, "title": "Thread", "description": "An existing thread." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["contact"] }, "accountLinkId": { "allOf": [ { "$ref": "#/components/schemas/Cuid2" }, { "description": "The account link to send from." } ] }, "contactId": { "$ref": "#/components/schemas/Cuid2" } }, "required": ["type", "accountLinkId", "contactId"], "additionalProperties": false, "title": "Contact", "description": "The contact's profile on the account link's platform, in its existing thread or a new one. Fails with `recipientUnavailable` when the contact has none there, and `profileAmbiguous` when it has several." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["profile"] }, "accountLinkId": { "allOf": [ { "$ref": "#/components/schemas/Cuid2" }, { "description": "The account link to send from." } ] }, "platform": { "allOf": [ { "$ref": "#/components/schemas/Platform" }, { "description": "Must be the account link's platform." } ] }, "platformId": { "type": "string", "minLength": 1, "description": "The person's ID on the platform. Reaching someone Inboxapp hasn't stored needs the account link's `profile:resolve:id`." } }, "required": ["type", "accountLinkId", "platform", "platformId"], "additionalProperties": false, "title": "Profile by platform ID", "description": "A platform user, in its existing thread or a new one. Without the Advanced API add-on, the profile must already belong to one of the team's contacts." }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["profile"] }, "accountLinkId": { "allOf": [ { "$ref": "#/components/schemas/Cuid2" }, { "description": "The account link to send from." } ] }, "platform": { "allOf": [ { "$ref": "#/components/schemas/Platform" }, { "description": "Must be the account link's platform." } ] }, "username": { "type": "string", "minLength": 1, "description": "The person's username on the platform, without a display prefix such as `@`. On LinkedIn, what follows `/in/` in their profile URL: the vanity name or the `ACoA…` profile ID. Reaching someone Inboxapp hasn't stored needs the account link's `profile:resolve:username`.", "examples": ["jane", "ACoAABcdEfGh1234567890"] } }, "required": ["type", "accountLinkId", "platform", "username"], "additionalProperties": false, "title": "Profile by username", "description": "A platform user, in its existing thread or a new one. Without the Advanced API add-on, the profile must already belong to one of the team's contacts." } ] }, "content": { "type": "string", "minLength": 1, "description": "Up to the platform's `limits.characters`. Longer content fails with `contentRejected`." }, "replyToMessageId": { "allOf": [ { "$ref": "#/components/schemas/Cuid2" }, { "description": "A message in the thread this send lands in, to reply to." } ] } }, "required": ["target", "content"], "additionalProperties": false }, "InvalidCursor": { "type": "object", "properties": { "code": { "type": "string", "enum": ["invalidCursor"] }, "message": { "type": "string" }, "details": { "type": "null" }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "MessagePage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass it back as `cursor`, with the same filters, to read the next page. Null on the last page." } }, "required": ["data", "nextCursor"], "additionalProperties": false, "description": "Ordered by `createdAt`, newest first unless `order` is `asc`." }, "TypingSignal": { "type": "object", "properties": { "status": { "type": "string", "enum": ["sent", "skipped"] }, "reason": { "anyOf": [ { "type": "string", "enum": ["rateLimited", "disabled"] }, { "type": "null" } ], "description": "Why it was skipped: `disabled` when `typingIndicators` is off for the thread, `rateLimited` when one was sent for the thread moments ago. Null when sent." } }, "required": ["status", "reason"], "additionalProperties": false }, "ThreadDeletion": { "type": "object", "properties": { "scope": { "type": "string", "enum": ["remoteAndLocal", "local"], "description": "`remoteAndLocal` when the conversation was also deleted on the platform. `local` when only Inboxapp's copy was, because the platform can't delete it or it never existed there." } }, "required": ["scope"], "additionalProperties": false }, "ThreadUpdate": { "type": "object", "properties": { "archived": { "type": "boolean", "description": "Also applied on the platform when the account link has `thread:archive:mutate`." }, "unread": { "type": "boolean", "description": "Marks the thread read or unread for the team owner. Also applied on the platform when the account link has `thread:read:mutate`." }, "assigneeId": { "anyOf": [ { "$ref": "#/components/schemas/Cuid2" }, { "type": "null" } ], "description": "The thread's own assignee. Null falls back to the contact's default." }, "typingIndicators": { "type": "string", "enum": ["enabled", "disabled", "teamDefault"], "description": "Whether Inboxapp sends typing indicators to the platform while someone composes in this thread. `teamDefault` follows the team's setting." } }, "additionalProperties": false, "description": "Omitted fields are left unchanged, and `null` clears a nullable field." }, "ThreadPage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass it back as `cursor`, with the same filters, to read the next page. Null on the last page." } }, "required": ["data", "nextCursor"], "additionalProperties": false, "description": "In inbox order, newest first unless `order` is `asc`." }, "PeopleSearchRateLimited": { "type": "object", "properties": { "code": { "type": "string", "enum": ["peopleSearchRateLimited"] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "accountLinkId": { "type": "string" }, "window": { "type": "string", "enum": ["minute", "hour", "day"] }, "limit": { "type": "integer" }, "resetAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" } }, "required": ["accountLinkId", "window", "limit", "resetAt"], "additionalProperties": false }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "PersonList": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Person" } }, "failures": { "type": "array", "items": { "$ref": "#/components/schemas/PeopleSearchFailure" }, "description": "The searched account links that returned nothing. When every one fails, the request fails with the first one's error instead." } }, "required": ["data", "failures"], "additionalProperties": false, "description": "Every searched account link's results in one list: closest name or username match first, then people the account already talks to or is connected with, then verified, then each platform's own order. Not paginated." }, "PeopleSearchFailure": { "type": "object", "properties": { "accountLinkId": { "type": "string" }, "code": { "type": "string", "enum": [ "accountLinkNotFound", "accountLinkDisconnected", "integrationSetupRequired", "capabilityNotSupported", "platformRateLimited", "peopleSearchRateLimited", "platformError", "platformUnavailable" ], "description": "The error code searching from this account link alone returns." }, "message": { "type": "string" } }, "required": ["accountLinkId", "code", "message"], "additionalProperties": false, "description": "An account link whose search failed, so `data` has nothing from it." }, "Person": { "type": "object", "properties": { "accountLinkId": { "type": "string", "description": "The account link that found this person. `threadId`, `canMessage`, `degree`, `closeness` and `target` are its view." }, "profile": { "anyOf": [ { "$ref": "#/components/schemas/Profile" }, { "$ref": "#/components/schemas/ProfileHit" } ] }, "contactId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The team's contact holding this profile, if any." }, "threadId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The account link's latest thread with this profile, if any." }, "canMessage": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "The platform's hint that the account link can message this person, `null` when the platform doesn't say. A send can still fail with `recipientUnavailable`." }, "degree": { "anyOf": [ { "type": "string", "enum": ["self", "first", "second", "third", "outOfNetwork"] }, { "type": "null" } ], "description": "How close the person is to the account link on the platform's network, as the search states it. `null` when it states none." }, "closeness": { "type": "string", "enum": ["connected", "near", "none"], "description": "`connected` for a direct tie such as a follow or 1st-degree connection, `near` for a shared one such as mutuals or 2nd degree." }, "target": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": ["profile"] }, "accountLinkId": { "$ref": "#/components/schemas/Cuid2" }, "platform": { "$ref": "#/components/schemas/Platform" }, "platformId": { "type": "string", "minLength": 1, "description": "The person's ID on the platform. Reaching someone Inboxapp hasn't stored needs the account link's `profile:resolve:id`." } }, "required": ["type", "accountLinkId", "platform", "platformId"], "additionalProperties": false, "title": "Profile by platform ID" }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["profile"] }, "accountLinkId": { "$ref": "#/components/schemas/Cuid2" }, "platform": { "$ref": "#/components/schemas/Platform" }, "username": { "type": "string", "minLength": 1, "description": "The person's username on the platform, without a display prefix such as `@`. On LinkedIn, what follows `/in/` in their profile URL: the vanity name or the `ACoA…` profile ID. Reaching someone Inboxapp hasn't stored needs the account link's `profile:resolve:username`.", "examples": ["jane", "ACoAABcdEfGh1234567890"] } }, "required": ["type", "accountLinkId", "platform", "username"], "additionalProperties": false, "title": "Profile by username" } ], "description": "Pass as is as the `target` of Send message or Send connection request to reach this person from the account link." } }, "required": [ "accountLinkId", "profile", "contactId", "threadId", "canMessage", "degree", "closeness", "target" ], "additionalProperties": false, "description": "A person one of the searched account links found." }, "ProfileHit": { "type": "object", "properties": { "id": { "type": "null", "description": "Inboxapp hasn't stored this profile. Search with `enrich=true` to get only stored profiles." }, "platform": { "$ref": "#/components/schemas/Platform" }, "platformId": { "type": "string", "description": "The ID the platform gives this object. Only meaningful next to its `platform`." }, "username": { "anyOf": [ { "type": "string", "description": "The platform username, without a display prefix such as `@`.", "examples": ["jane"] }, { "type": "null" } ] }, "handle": { "type": "string", "description": "The username as the platform displays it. Show this, and look up by `username`.", "examples": ["@jane"] }, "displayName": { "type": "string" }, "avatarUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "verified": { "type": "boolean", "description": "The platform vouches for the account, such as with an X badge. Platform-specific badges are in `platformData`." }, "isOrganization": { "type": "boolean", "description": "A company or page rather than a person." }, "profileUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformData": { "$ref": "#/components/schemas/ProfilePlatformData" } }, "required": [ "id", "platform", "platformId", "username", "handle", "displayName", "avatarUrl", "verified", "isOrganization", "profileUrl", "platformData" ], "additionalProperties": false, "description": "A profile the platform's search returned that Inboxapp hasn't stored, with only what identifies it." }, "ContactUpdate": { "type": "object", "properties": { "status": { "anyOf": [ { "type": "string", "description": "A status, by ID or by name. Names match ignoring case and accents. When a value is one status's ID and another's name, the ID wins." }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "valuation": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "assigneeId": { "anyOf": [ { "$ref": "#/components/schemas/Cuid2" }, { "type": "null" } ], "description": "The default assignee of this contact's threads that have none of their own." } }, "additionalProperties": false, "description": "Omitted fields are left unchanged, and `null` clears a nullable field." }, "ContactPage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass it back as `cursor`, with the same filters, to read the next page. Null on the last page." } }, "required": ["data", "nextCursor"], "additionalProperties": false, "description": "Ordered by `createdAt`, oldest first." }, "AccountLinkPage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AccountLink" } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass it back as `cursor`, with the same filters, to read the next page. Null on the last page." } }, "required": ["data", "nextCursor"], "additionalProperties": false, "description": "Ordered by `createdAt`, oldest first." }, "MemberNotFound": { "type": "object", "properties": { "code": { "type": "string", "enum": ["memberNotFound"] }, "message": { "type": "string" }, "details": { "type": "null" }, "requestId": { "type": "string" } }, "required": ["code", "message", "details", "requestId"], "additionalProperties": false }, "MemberPage": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pass it back as `cursor`, with the same filters, to read the next page. Null on the last page." } }, "required": ["data", "nextCursor"], "additionalProperties": false, "description": "Ordered by `createdAt`, oldest first." }, "Team": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string", "description": "The team's URL segment in Inboxapp." }, "imageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "type": "string", "description": "The ISO 4217 code contact valuations are in.", "examples": ["USD"] }, "allowSupportAccess": { "type": "boolean", "description": "Whether the team lets Inboxapp support open its workspace." }, "createdAt": { "type": "string", "examples": ["2026-09-14T10:32:00.000Z"], "format": "date-time" } }, "required": [ "id", "name", "slug", "imageUrl", "currency", "allowSupportAccess", "createdAt" ], "additionalProperties": false, "description": "The team the API token belongs to." }, "PlatformInfo": { "type": "object", "properties": { "platform": { "$ref": "#/components/schemas/Platform" }, "name": { "type": "string", "examples": ["X"] }, "usernamePrefix": { "type": "string", "description": "Prepended to a `username` to display it. Empty when the platform uses none.", "examples": ["@"] }, "capabilities": { "type": "array", "items": { "type": "string", "enum": [ "message:send", "message:edit", "message:delete:self", "message:unsend", "message:react", "message:reply", "message:forward", "media:image", "media:video", "media:gif", "media:file", "media:audio", "thread:typing:send", "thread:typing:receive", "thread:message-requests", "thread:delete:remote", "directory:typeahead", "thread:archive:observe", "thread:archive:mutate", "thread:read:observe", "thread:read:mutate", "profile:follow", "profile:unfollow", "profile:connect", "profile:connect:note", "profile:resolve:id", "profile:resolve:username" ] }, "description": "The platform's baseline. Each account link narrows it in its own `capabilities`." }, "limits": { "type": "object", "properties": { "characters": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum characters in a message, counting an emoji as one. Null when the platform sets none." }, "mediaCount": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum attachments in a message. Null when the platform sets none." }, "mediaBytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum size of one attachment. Null when the platform sets none." }, "mediaTypes": { "anyOf": [ { "type": "object", "properties": { "image": { "type": "array", "items": { "type": "string" } }, "video": { "type": "array", "items": { "type": "string" } }, "gif": { "type": "array", "items": { "type": "string" } }, "file": { "type": "array", "items": { "type": "string" } }, "audio": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, { "type": "null" } ], "description": "Accepted formats per media kind: MIME types, families such as `image/*`, or extensions such as `.pdf`. A kind without an entry accepts nothing. Null accepts any format." }, "connectNoteCharacters": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Maximum characters in the note of a connection request. Null when the platform sets none." } }, "required": [ "characters", "mediaCount", "mediaBytes", "mediaTypes", "connectNoteCharacters" ], "additionalProperties": false, "description": "Limits checked before a request reaches the platform." }, "mutationWindows": { "type": "object", "properties": { "message:send": { "type": "integer" }, "message:edit": { "type": "integer" }, "message:delete:self": { "type": "integer" }, "message:unsend": { "type": "integer" }, "message:react": { "type": "integer" }, "message:reply": { "type": "integer" }, "message:forward": { "type": "integer" }, "media:image": { "type": "integer" }, "media:video": { "type": "integer" }, "media:gif": { "type": "integer" }, "media:file": { "type": "integer" }, "media:audio": { "type": "integer" }, "thread:typing:send": { "type": "integer" }, "thread:typing:receive": { "type": "integer" }, "thread:message-requests": { "type": "integer" }, "thread:delete:remote": { "type": "integer" }, "directory:typeahead": { "type": "integer" }, "thread:archive:observe": { "type": "integer" }, "thread:archive:mutate": { "type": "integer" }, "thread:read:observe": { "type": "integer" }, "thread:read:mutate": { "type": "integer" }, "profile:follow": { "type": "integer" }, "profile:unfollow": { "type": "integer" }, "profile:connect": { "type": "integer" }, "profile:connect:note": { "type": "integer" }, "profile:resolve:id": { "type": "integer" }, "profile:resolve:username": { "type": "integer" } }, "additionalProperties": false, "description": "Seconds after a message's `createdAt` during which a capability still applies to it, such as `message:edit`. A capability without an entry has no window." }, "threadState": { "type": "object", "properties": { "archive": { "anyOf": [ { "type": "object", "properties": { "observe": { "type": "boolean", "description": "Inboxapp reads this state from the platform." }, "mutate": { "type": "boolean", "description": "Changing it in Inboxapp also changes it on the platform." } }, "required": ["observe", "mutate"], "additionalProperties": false }, { "type": "null" } ], "description": "Null when the platform has no such state." }, "read": { "anyOf": [ { "type": "object", "properties": { "observe": { "type": "boolean", "description": "Inboxapp reads this state from the platform." }, "mutate": { "type": "boolean", "description": "Changing it in Inboxapp also changes it on the platform." } }, "required": ["observe", "mutate"], "additionalProperties": false }, { "type": "null" } ], "description": "Null when the platform has no such state." } }, "required": ["archive", "read"], "additionalProperties": false } }, "required": [ "platform", "name", "usernamePrefix", "capabilities", "limits", "mutationWindows", "threadState" ], "additionalProperties": false, "description": "What a platform supports. Account links narrow its capabilities, and threads narrow them further through `restrictions`." } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "Bearer" } } }, "security": [], "tags": [ { "name": "Platforms", "description": "The messaging platforms available to the team, with what each one supports." }, { "name": "Team", "description": "The team the API token belongs to, and its members: the Inboxapp users who work in it." }, { "name": "Account Links", "description": "Platform accounts the team connected to Inboxapp. Every thread belongs to one, and messages are sent from one." }, { "name": "Contacts", "description": "The team's record of a person, holding its CRM state: status, tags, notes, valuation and default assignee. A contact groups one or more profiles, a person's accounts on the platforms." }, { "name": "People", "description": "People on the platforms, found through the team's account links whether or not Inboxapp knows them yet." }, { "name": "Threads", "description": "Conversations between one of the team's account links and one profile." }, { "name": "Messages", "description": "Messages in a thread, and sending, editing, unsending and reacting to them on the platform." }, { "name": "Relationships", "description": "How an account link stands with a profile on the platform, and requests that change it." }, { "name": "Tags", "description": "Labels the team puts on contacts." }, { "name": "Statuses", "description": "The pipeline stages a contact can be in, such as a deal stage. A contact has at most one." }, { "name": "Colors", "description": "The colors of Inboxapp's palette, for tags and statuses." }, { "name": "Events", "description": "Changes in the team, as delivered to v2 webhooks. Each event names the object that changed and carries only the values of the change; read the object for its current state. Events are kept for 7 days, up to 25,000 per team." } ], "servers": [ { "url": "https://inboxapp.com/api/v2" } ], "webhooks": { "thread.created": { "post": { "summary": "Thread created", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadCreatedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "thread.deleted": { "post": { "summary": "Thread deleted", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadDeletedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "thread.assigned": { "post": { "summary": "Thread assigned", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadAssignedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "thread.unassigned": { "post": { "summary": "Thread unassigned", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadUnassignedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "thread.archived": { "post": { "summary": "Thread archived", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadArchivedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "thread.unarchived": { "post": { "summary": "Thread unarchived", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadUnarchivedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "thread.typing": { "post": { "summary": "Thread typing", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreadTypingEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "message.sent": { "post": { "summary": "Message sent", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageSentEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "message.received": { "post": { "summary": "Message received", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageReceivedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "message.edited": { "post": { "summary": "Message edited", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageEditedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "message.deleted": { "post": { "summary": "Message deleted", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageDeletedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "message.reactionAdded": { "post": { "summary": "Message reaction added", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageReactionAddedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "message.reactionRemoved": { "post": { "summary": "Message reaction removed", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageReactionRemovedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "contact.statusChanged": { "post": { "summary": "Contact status changed", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactStatusChangedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "contact.tagsChanged": { "post": { "summary": "Contact tags changed", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactTagsChangedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "contact.notesChanged": { "post": { "summary": "Contact notes changed", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactNotesChangedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "contact.valuationChanged": { "post": { "summary": "Contact valuation changed", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactValuationChangedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "contact.assigneeChanged": { "post": { "summary": "Contact assignee changed", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactAssigneeChangedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "tag.created": { "post": { "summary": "Tag created", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagCreatedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "tag.updated": { "post": { "summary": "Tag updated", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagUpdatedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "tag.deleted": { "post": { "summary": "Tag deleted", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagDeletedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "status.created": { "post": { "summary": "Status created", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusCreatedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "status.updated": { "post": { "summary": "Status updated", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusUpdatedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "status.deleted": { "post": { "summary": "Status deleted", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusDeletedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "campaign.created": { "post": { "summary": "Campaign created", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignCreatedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "campaign.started": { "post": { "summary": "Campaign started", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignStartedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "campaign.paused": { "post": { "summary": "Campaign paused", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignPausedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "campaign.resumed": { "post": { "summary": "Campaign resumed", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignResumedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "campaign.completed": { "post": { "summary": "Campaign completed", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignCompletedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "target.contacted": { "post": { "summary": "Target contacted", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetContactedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "target.followUpSent": { "post": { "summary": "Target follow up sent", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetFollowUpSentEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "target.replied": { "post": { "summary": "Target replied", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetRepliedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "connectionRequest.sent": { "post": { "summary": "Connection request sent", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionRequestSentEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "connectionRequest.accepted": { "post": { "summary": "Connection request accepted", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionRequestAcceptedEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } }, "connectionRequest.withdrawn": { "post": { "summary": "Connection request withdrawn", "tags": ["Events"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionRequestWithdrawnEvent" } } } }, "responses": { "200": { "description": "Any 2xx acknowledges it." } } } } } }