TripleBooks
CRM

Email

POST
/api/crm/outbound-email

Authorization: Bearer ak_.... Required scope: write:crm. Pass entityId query or JSON body (must match the key’s entity). Session cookie auth with x-entity-id is also supported in the browser.

Authorization

bearerAuth
AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/crm/outbound-email?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "leadId": "3c6e2b8e-0e8f-48db-8791-27271df10113",    "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",    "channel": "gmail",    "subject": "string",    "htmlBody": "string"  }'
Empty
{  "error": "string"}
GET
/api/crm/outbound-email-connections

Authorization: Bearer ak_.... Required scope: read:crm. Pass entityId query (must match the key’s entity). Session cookie auth with x-entity-id is also supported in the browser.

Authorization

bearerAuth
AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

curl -X GET "https://example.com/api/crm/outbound-email-connections?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty
POST
/api/crm/outbound-email/{messageId}/send

Send an approved CRM email draft. Authorization: Bearer ak_.... Required scope includes write:crm. Requests are scoped to one entity. Pass entityId as a query parameter, JSON field, or x-entity-id header. API keys are already pinned to an entity.

Authorization

bearerAuth
AuthorizationBearer <token>

Create keys under Settings → API keys. Prefix ak_. Send as Authorization: Bearer ak_....

In: header

Path Parameters

messageId*string
Formatuuid

Query Parameters

entityId*string

Entity UUID; must match the API key’s entity when using Bearer auth.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/crm/outbound-email/497f6eca-6276-4993-bfeb-53cbbbba6f08/send?entityId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty
{  "error": "string"}
{  "error": "string"}
{  "error": "string"}
{  "error": "string"}

On this page