Email

Manage email campaigns, templates, recipients, and tracking.

POST

Send transactional email

/organizations/{organizationId}/projects/{projectId}/apps/email/{appId}/actions/send

Sends a single transactional email to a specific recipient using an email template. Used for one-off emails like order confirmations, password resets, etc.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

BodyRequired

toRequired

string

locale

stringRecipient locale (e.g., 'en', 'fr'). Resolves TranslatableString fields and passes through to block rendering. Defaults to 'en'.

emailSlugRequired

stringEmail template slug

variables

objectTemplate variables to replace

skipTracking

booleanSkip adding tracking pixel/links

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const org = "org_123";6const project = "proj_123";7const app = "app_123";8const data = { to: "user@example.com", subject: "Hello", body: "World" };9
10const { data: result } = await gc.email.sendTransactionalEmail(org, project, app, data);

GET

Contact email timeline

/organizations/{organizationId}/projects/{projectId}/apps/email/{appId}/contacts/{contactId}/timeline

Returns the unified email timeline for a contact: past sends + planned sends (including staged sends from a Mind sends draft when present), each with per-send engagement stats (opens, clicks, bounced, complained). Each send carries its `draftId` (non-null only while staged in a ready draft). The response-level `draftId` points at the contact's active sends draft when one exists — use it to render accept/reject UI. Order is COALESCE(sent_at, scheduled_for, created_at) DESC so upcoming planned sends appear at the top, then recent sent, then older.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

contactIdRequired

path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { data: emailTimeline } = await gc.email.getContactEmailTimeline({6  organizationId: "org_123",7  projectId: "proj_123",8  appId: "app_123",9  contactId: "contact_123"10});

GET

Get email template

/organizations/{organizationId}/projects/{projectId}/apps/email/{appId}/emails/{emailId}

Returns a single email template by ID, including name, subject line, full content blocks, header/footer references, and timestamps.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

emailIdRequired

path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { data: email } = await gc.email.getEmail({6  organizationId: "org_123",7  projectId: "proj_123",8  appId: "app_123",9  emailId: "email_123"10});

GET

Get email recipient

/organizations/{organizationId}/projects/{projectId}/apps/email/{appId}/emails/{emailId}/recipients/{recipientId}

Returns a single recipient row with subscription state.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

emailIdRequired

path · string

recipientIdRequired

path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { data: recipient } = await gc.email.getEmailRecipient({6  organizationId: "org_123",7  projectId: "proj_123",8  appId: "app_123",9  emailId: "email_123",10  recipientId: "rec_123"11});

POST

Unsubscribe a recipient

/organizations/{organizationId}/projects/{projectId}/apps/email/{appId}/emails/{emailId}/recipients/{recipientId}/unsubscribe

Soft-unsubscribes a recipient by setting unsubscribed_at and an optional reason. The row is preserved for audit + resubscribe.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

emailIdRequired

path · string

recipientIdRequired

path · string

BodyRequired

reason

string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const orgId = "org-id";6const projectId = "project-id";7const appId = "app-id";8const emailId = "email-id";9const recipientId = "recipient-id";10const data = {};11
12const { data: result } = await gc.email.unsubscribeEmailRecipient(orgId, projectId, appId, emailId, recipientId, data);

GET

List email recipients

/organizations/{organizationId}/projects/{projectId}/apps/email/{appId}/emails/{emailId}/recipients

Returns the subscribers for a specific email template. Includes currently subscribed and previously unsubscribed contacts.

Parameters

page

query · number

pageSize

query · number

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

emailIdRequired

path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { data: recipients } = await gc.email.getEmailRecipients({6  organizationId: "org-id",7  projectId: "project-id",8  appId: "app-id",9  emailId: "email-id"10});

POST

Subscribe a contact

/organizations/{organizationId}/projects/{projectId}/apps/email/{appId}/emails/{emailId}/recipients

Adds a contact as a recipient of this email. If the contact was previously unsubscribed, the row is resurrected (unsubscribed_at cleared).

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

emailIdRequired

path · string

BodyRequired

contactIdRequired

string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const organizationId = "org_123";6const projectId = "proj_123";7const appId = "app_123";8const emailId = "email_123";9const data = { email: "user@example.com" };10
11const { data: subscription } = await gc.email.subscribeEmailRecipient({12  organizationId,13  projectId,14  appId,15  emailId,16  data17});

GET

Get email templates

/organizations/{organizationId}/projects/{projectId}/apps/email/{appId}/emails

Returns a list of all email templates for the specified app. Each template includes its name, subject line, content blocks, and associated header/footer references.

Parameters

page

query · number

pageSize

query · number

query · string

lite

query · stringWhen 'true', return only essential fields (id, name, subject) without content.

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { data: emails } = await gc.email.getEmails({6  organizationId: "org_123",7  projectId: "proj_123",8  appId: "app_123"9});

GET

Get email footer

/organizations/{organizationId}/projects/{projectId}/apps/email/{appId}/footers/{footerId}

Returns a single email footer by ID, including its name, content blocks, and timestamps.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

footerIdRequired

path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { data: footer } = await gc.email.getEmailFooter({6  organizationId: "org_123",7  projectId: "proj_123",8  appId: "app_123",9  footerId: "footer_123"10});

GET

Get email footers

/organizations/{organizationId}/projects/{projectId}/apps/email/{appId}/footers

Returns a list of all email footers for the specified app. Footers contain branding, unsubscribe links, and legal text appended to emails.

Parameters

page

query · number

pageSize

query · number

query · string

lite

query · stringWhen 'true', return only essential fields (id, name, subject) without content.

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { data: emailFooters } = await gc.email.listEmailFooters({6  organizationId: "org_123",7  projectId: "proj_123",8  appId: "app_123"9});

GET

Get email header

/organizations/{organizationId}/projects/{projectId}/apps/email/{appId}/headers/{headerId}

Returns a single email header by ID, including its name, content blocks, and timestamps.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

headerIdRequired

path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { data: emailHeader } = await gc.email.getEmailHeader({6  organizationId: "org-id",7  projectId: "project-id",8  appId: "app-id",9  headerId: "header-id"10});

GET

Get email headers

/organizations/{organizationId}/projects/{projectId}/apps/email/{appId}/headers

Returns a list of all email headers for the specified app. Headers contain branding and navigation elements prepended to emails.

Parameters

page

query · number

pageSize

query · number

query · string

lite

query · stringWhen 'true', return only essential fields (id, name, subject) without content.

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { data: emailHeaders } = await gc.email.listEmailHeaders({6  organizationId: "org_123",7  projectId: "proj_123",8  appId: "app_123"9});

GET

Get email send with events

/organizations/{organizationId}/projects/{projectId}/apps/email/{appId}/sends/{sendId}

Returns a single send row and its full event log (delivered/open/click/bounce/complaint/unsubscribe).

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

sendIdRequired

path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { data: emailSend } = await gc.email.getEmailSend({6  organizationId: "org-id",7  projectId: "project-id",8  appId: "app-id",9  sendId: "send-id"10});

PATCH

Update send

/organizations/{organizationId}/projects/{projectId}/apps/email/{appId}/sends/{sendId}

Reschedule, cancel, or adjust metadata on a send row. Cannot modify rows with status='sent' or status='failed'.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

sendIdRequired

path · string

BodyRequired

status

union

metadata

object

scheduledFor

union

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { data: emailSend } = await gc.email.updateEmailSend({6  organizationId: "org_123",7  projectId: "proj_123",8  appId: "app_123",9  sendId: "send_123",10  data: {11    status: "sent"12  }13});

GET

List email sends

/organizations/{organizationId}/projects/{projectId}/apps/email/{appId}/sends

Returns the log of sends (past + planned + queued) for this email app. Filter by email, contact, or status. Sorted by effective time (sent_at, then scheduled_for, then created_at) descending.

Parameters

page

query · number

pageSize

query · number

emailId

query · string

contactId

query · string

status

query · union

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { data: emailSends } = await gc.email.getEmailSends({6  organizationId: "org_123",7  projectId: "proj_123",8  appId: "app_123"9});

POST

Create a planned send

/organizations/{organizationId}/projects/{projectId}/apps/email/{appId}/sends

Creates a send row. Mind writes status='planned' rows that it reorders as new CRM activity lands. When Mind commits to firing, it transitions to status='queued' with scheduled_for set; a worker picks it up.

Parameters

organizationIdRequired

path · string

projectIdRequired

path · string

appIdRequired

path · string

BodyRequired

locale

string

status

union

emailIdRequired

string

metadata

object

contactIdRequired

string

scheduledFor

string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { data: emailSend } = await gc.email.createEmailSend({6  organizationId: "org_123",7  projectId: "proj_123",8  appId: "app_123",9  data: {}10});

Built byHuman

This content was designed and written by a human.