Email

Manage email campaigns, templates, recipients, and tracking.

POST

Send transactional email

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

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 { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11
12const result = await gc.email.sendTransactionalEmail({13  organizationId: orgs[0].id,14  projectId: projects[0].id,15  appId: apps[0].id,16  data: {17    to: "user@example.com",18    subject: "Hello",19    html: "<p>World</p>"20  }21});22

GET

Get one contact's sent and planned emails with per-send opens and clicks

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

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 { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { contacts } = await gc.contacts.listContacts({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16
17const { timeline } = await gc.email.getContactEmailTimeline({18  organizationId: orgs[0].id,19  projectId: projects[0].id,20  appId: apps[0].id,21  contactId: contacts[0].id,22});23

GET

Get one email with its full content blocks and header/footer links

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

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 { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { emails } = await gc.email.listEmails({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16
17const email = await gc.email.getEmail({18  organizationId: orgs[0].id,19  projectId: projects[0].id,20  appId: apps[0].id,21  emailId: emails[0].id,22});23

DELETE

Delete email

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

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 { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7
8const result = await gc.email.deleteEmail({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  appId: "YOUR_APP_ID",12  emailId: "YOUR_EMAIL_ID",13});14

PATCH

Update an email's name, slug, subject, preheader and send-trigger sentence, not content or status

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

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string
emailIdRequired: path · string

BodyRequired

name: stringInternal use only
slug: stringInternal reference for this email. Emails are sent rather than served, so this is not a public URL and changing it breaks no link.
subject: union
footerId: unionThe footer this email renders with. Discover ids with listEmailFooters. Null unbinds and falls back to the app default.
headerId: unionThe header this email renders with. Discover ids with listEmailHeaders. Null unbinds and falls back to the app default.
preheader: unionTranslatableString. The line most inboxes print beside the subject. Null clears it, and the client then falls back to whatever the body opens with.
triggerDescription: union

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7
8const result = await gc.email.updateEmailMeta({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  appId: "app_123",12  emailId: "email_123",13  data: {},14});15

GET

List emails in an email app, newest first; pass lite=true to skip content

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

Parameters

page: query · number
pageSize: query · number
lite: query · string
sort: query · string
search: query · string
status: query · string
slug: query · string
name: query · string
headerId: query · string
footerId: query · string
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 { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11
12const { emails } = await gc.emails.listEmails({13  organizationId: orgs[0].id,14  projectId: projects[0].id,15  appId: apps[0].id,16});17

GET

Get one footer's block content in full; listEmailFooters lite=true returns metadata only

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

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 { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { footers } = await gc.email.listEmailFooters({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16
17const footer = await gc.email.getEmailFooter({18  organizationId: orgs[0].id,19  projectId: projects[0].id,20  appId: apps[0].id,21  footerId: footers[0].id,22});23

DELETE

Delete email footer

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

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 { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { footers } = await gc.email.listEmailFooters({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16
17const result = await gc.email.deleteEmailFooter({18  organizationId: orgs[0].id,19  projectId: projects[0].id,20  appId: apps[0].id,21  footerId: footers[0].id,22});23

GET

List footers in an email app, newest first; pass lite=true to skip content

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

Parameters

page: query · number
pageSize: query · number
lite: query · string
sort: query · string
search: query · string
name: query · string
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 { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11
12const { emailFooters } = await gc.email.listEmailFooters({13  organizationId: orgs[0].id,14  projectId: projects[0].id,15  appId: apps[0].id,16});17

POST

Create a footer shell; only name is required, add blocks afterwards

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

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string

BodyRequired

nameRequired: string
content: array

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11
12const footer = await gc.email.createEmailFooter({13  organizationId: orgs[0].id,14  projectId: projects[0].id,15  appId: apps[0].id,16  data: {},17});18

GET

Get one header's full block tree; no lite mode, so expect heavy output

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

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 { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7
8const appId = "your-app-id";9const headerId = "your-header-id";10
11const result = await gc.email.getEmailHeader({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId,15  headerId,16});17

DELETE

Delete email header

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

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 { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { headers } = await gc.email.listEmailHeaders({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16
17const result = await gc.email.deleteEmailHeader({18  organizationId: orgs[0].id,19  projectId: projects[0].id,20  appId: apps[0].id,21  headerId: headers[0].id,22});23

GET

List headers in an email app, newest first; pass lite=true to skip content

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

Parameters

page: query · number
pageSize: query · number
lite: query · string
sort: query · string
search: query · string
name: query · string
createdAt: query · string
updatedAt: query · string
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 { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11
12const { headers } = await gc.email.listEmailHeaders({13  organizationId: orgs[0].id,14  projectId: projects[0].id,15  appId: apps[0].id,16});17

POST

Create a header shell; only name is required, add blocks afterwards

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

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string

BodyRequired

nameRequired: string
content: array

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11
12const result = await gc.email.createEmailHeader({13  organizationId: orgs[0].id,14  projectId: projects[0].id,15  appId: apps[0].id,16  data: {},17});18

GET

Get one send with its full delivery and engagement event log

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

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 { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11const { sends } = await gc.email.listEmailSends({12  organizationId: orgs[0].id,13  projectId: projects[0].id,14  appId: apps[0].id,15});16
17const { send } = await gc.email.getEmailSend({18  organizationId: orgs[0].id,19  projectId: projects[0].id,20  appId: apps[0].id,21  sendId: sends[0].id,22});23

PATCH

Update a send to reschedule or cancel; only planned and queued rows accept edits

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

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 { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7
8const result = await gc.email.updateEmailSend({9  organizationId: orgs[0].id,10  projectId: projects[0].id,11  appId: "app-id",12  sendId: "send-id",13  data: {},14});15

GET

List past, queued and planned sends across the app, filterable by email or contact

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

Parameters

page: query · number
pageSize: query · number
lite: query · string
sort: query · string
search: query · string
emailId: query · string
contactId: query · string
status: query · string
locale: query · string
recipientEmail: query · string
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 { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11
12const { emailSends } = await gc.email.listEmailSends({13  organizationId: orgs[0].id,14  projectId: projects[0].id,15  appId: apps[0].id,16});17

POST

Create a send for one contact; defaults to planned, which sends nothing until queued

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

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 { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11
12const result = await gc.email.createEmailSend({13  organizationId: orgs[0].id,14  projectId: projects[0].id,15  appId: apps[0].id,16  data: {},17});18

BuiltAutonomously With AI

This content was built autonomously. Giant Context analyzed the site, determined what was missing, created and submitted an idea and draft, which Giant Context staff accepted and published.