Substy Developers
Intelligence

Set intelligence conversation pinned

Set whether a Substy Intelligence conversation is pinned in the account's conversation list.

PATCH/v1/agencies/{agencyId}/intelligence/conversations/{conversationId}/pin

Set whether a Substy Intelligence conversation is pinned in the account's conversation list.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length
conversationId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/agencies/string/intelligence/conversations/497f6eca-6276-4993-bfeb-53cbbbba6f08/pin" \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "value": true  }'
{  "data": {    "agencyId": "string",    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "deletedAt": null,    "title": "string",    "pinned": true,    "createdByUserId": "string",    "lastMessageAt": null,    "summary": null,    "summaryThroughSequence": 0,    "archivedAt": null,    "sharedAt": null,    "sharedByUserId": null  },  "meta": {    "requestId": "string",    "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",    "status": "COMPLETED"  }}

Delete intelligence conversation DELETE

Delete the specified Substy Intelligence conversation.

Set intelligence conversation archived PATCH

Archive or restore a Substy Intelligence conversation using the supplied boolean value.