API reference

Every public API operation, generated from the OpenAPI contract, version 1.3.1. Paths are relative to https://api.senpede.com. Every call needs an API key or OAuth token, and errors use the standard envelope.

Download openapi.json Node.js SDK Changelog

Jump to an operation

Audiences
Broadcasts
- POST Create a campaign to a supplied recipient list and submit it for approval
Campaigns
Consent
Contacts
Journeys
Messages
- POST Send one transactional message to one contact
- GET Read one message's delivery status
Sandbox
- GET Messages the sandbox captured instead of sending, newest first
- POST Simulate a delivery receipt, read, failure, reply or opt-out for a sent message
Templates and channels
- GET The organization's channels, to choose one to send with
- GET Message templates, APPROVED unless `status` says otherwise
Tenant organizations
Usage
- GET Allowances for the current billing period, and how much of each is used
- GET Partners only: each tenant organization's usage this billing period
Webhook endpoints
OAuth
- POST Get an access token (client credentials grant)

Audiences

GET/api/v1/public/audiences

List audiences

Parameters

Parameters of GET /api/v1/public/audiences
Name	Type	Required	Description
page	`number`	Optional
pageSize	`number`	Optional

Returns 200 with a page of AudienceDto in data, with pagination.

POST/api/v1/public/audiences

Create an empty STATIC audience; add contacts with …/members

Request body CreateStaticAudienceDto

Request body of POST /api/v1/public/audiences
Name	Type	Required	Description
name	`string`	Required
description	`string`	Optional

Returns 201 with AudienceDto in data.

GET/api/v1/public/audiences/{audienceId}

Get one audience

Parameters

Parameters of GET /api/v1/public/audiences/{audienceId}
Name	Type	Required	Description
audienceId	`string`	Required

Returns 200 with AudienceDto in data.

DELETE/api/v1/public/audiences/{audienceId}

Delete a STATIC audience

Parameters

Parameters of DELETE /api/v1/public/audiences/{audienceId}
Name	Type	Required	Description
audienceId	`string`	Required

Returns 204 and no body.

GET/api/v1/public/audiences/{audienceId}/members

A STATIC audience's members

Parameters

Parameters of GET /api/v1/public/audiences/{audienceId}/members
Name	Type	Required
audienceId	`string`	Required
page	`number`	Optional
pageSize	`number`	Optional

Returns 200 with a page of AudienceMemberDto in data, with pagination.

POST/api/v1/public/audiences/{audienceId}/members

Add up to 500 contacts to a STATIC audience

By Senpede id, your own externalRef, or both. Any unknown contact fails the whole call; contacts already in the audience are left as they are.

Parameters

Parameters of POST /api/v1/public/audiences/{audienceId}/members
Name	Type	Required	Description
audienceId	`string`	Required

Request body PublicAddAudienceMembersDto

Request body of POST /api/v1/public/audiences/{audienceId}/members
Name	Type	Required	Description
contactIds	`string[]`	Optional
externalRefs	`string[]`	Optional

Returns 200 with AudienceMembersAddedDto in data.

DELETE/api/v1/public/audiences/{audienceId}/members/{contactId}

Remove a contact from a STATIC audience

Parameters

Parameters of DELETE /api/v1/public/audiences/{audienceId}/members/{contactId}
Name	Type	Required	Description
audienceId	`string`	Required
contactId	`string`	Required

Returns 204 and no body.

Broadcasts

POST/api/v1/public/broadcasts

Create a campaign to a supplied recipient list and submit it for approval

Request body CreateBroadcastDto

Request body of POST /api/v1/public/broadcasts
Name	Type	Required
sendWindowMode	`"ORGANIZATION" \| "CUSTOM" \| "NONE"`	Optional
sendWindow	SendWindowInputDto \| null	Optional
name	`string`	Required
description	`string`	Optional
type	`"MARKETING" \| "TRANSACTIONAL" \| "INFORMATIONAL" \| "OPERATIONAL" \| "CUSTOMER_SUCCESS"`	Optional
channelId	`string`	Required
templateId	`string`	Optional
message	`string`	Required
subject	`string`	Optional
messageHtml	`string`	Optional
recipients	BroadcastRecipientDto[]	Required

Returns 201 with BroadcastDto in data.

Campaigns

GET/api/v1/public/campaigns

List campaigns, optionally by status

Parameters

Parameters of GET /api/v1/public/campaigns
Name	Type	Required
page	`number`	Optional
pageSize	`number`	Optional
status	`"DRAFT" \| "PENDING_APPROVAL" \| "APPROVED" \| "SCHEDULED" \| "EXECUTING" \| "PAUSED" \| …`	Optional

Returns 200 with a page of CampaignDto in data, with pagination.

POST/api/v1/public/campaigns

Create a draft campaign against an existing audience

Request body CreateCampaignDto

Request body of POST /api/v1/public/campaigns
Name	Type	Required
sendWindowMode	`"ORGANIZATION" \| "CUSTOM" \| "NONE"`	Optional
sendWindow	SendWindowInputDto \| null	Optional
name	`string`	Required
description	`string`	Optional
type	`"MARKETING" \| "TRANSACTIONAL" \| "INFORMATIONAL" \| "OPERATIONAL" \| "CUSTOMER_SUCCESS"`	Optional
audienceId	`string`	Required
channelId	`string`	Optional
templateId	`string`	Optional
message	`string`	Required
subject	`string`	Optional
messageHtml	`string`	Optional
trackLinks	`boolean`	Optional

Returns 201 with CampaignDto in data.

GET/api/v1/public/campaigns/{campaignId}

Get one campaign with its status history

Parameters

Parameters of GET /api/v1/public/campaigns/{campaignId}
Name	Type	Required	Description
campaignId	`string`	Required

Returns 200 with CampaignDetailDto in data.

PATCH/api/v1/public/campaigns/{campaignId}

Update a draft campaign

Parameters

Parameters of PATCH /api/v1/public/campaigns/{campaignId}
Name	Type	Required	Description
campaignId	`string`	Required

Request body UpdateCampaignDto

Request body of PATCH /api/v1/public/campaigns/{campaignId}
Name	Type	Required
sendWindowMode	`"ORGANIZATION" \| "CUSTOM" \| "NONE"`	Optional
sendWindow	SendWindowInputDto \| null	Optional
name	`string`	Optional
description	`string`	Optional
type	`"MARKETING" \| "TRANSACTIONAL" \| "INFORMATIONAL" \| "OPERATIONAL" \| "CUSTOMER_SUCCESS"`	Optional
audienceId	`string`	Optional
channelId	`string`	Optional
templateId	`string`	Optional
message	`string`	Optional
subject	`string`	Optional
messageHtml	`string`	Optional
trackLinks	`boolean`	Optional

Returns 200 with CampaignDto in data.

POST/api/v1/public/campaigns/{campaignId}/cancel

Cancel a campaign; pending deliveries are dropped

Parameters

Parameters of POST /api/v1/public/campaigns/{campaignId}/cancel
Name	Type	Required	Description
campaignId	`string`	Required

Request body TransitionReasonDto

Request body of POST /api/v1/public/campaigns/{campaignId}/cancel
Name	Type	Required	Description
reason	`string`	Optional

Returns 200 with CampaignDto in data.

GET/api/v1/public/campaigns/{campaignId}/messages

A campaign's messages with their delivery status, receipts, replies and clicks

Parameters

Parameters of GET /api/v1/public/campaigns/{campaignId}/messages
Name	Type	Required
campaignId	`string`	Required
page	`number`	Optional
pageSize	`number`	Optional
status	`"PENDING" \| "SENT" \| "FAILED" \| "SKIPPED"`	Optional

Returns 200 with a page of CampaignMessageDto in data, with pagination.

GET/api/v1/public/campaigns/{campaignId}/messages/{messageId}

One of a campaign's messages

Parameters

Parameters of GET /api/v1/public/campaigns/{campaignId}/messages/{messageId}
Name	Type	Required	Description
campaignId	`string`	Required
messageId	`string`	Required

Returns 200 with CampaignMessageDto in data.

POST/api/v1/public/campaigns/{campaignId}/pause

Pause an executing campaign

Parameters

Parameters of POST /api/v1/public/campaigns/{campaignId}/pause
Name	Type	Required	Description
campaignId	`string`	Required

Request body TransitionReasonDto

Request body of POST /api/v1/public/campaigns/{campaignId}/pause
Name	Type	Required	Description
reason	`string`	Optional

Returns 200 with CampaignDto in data.

POST/api/v1/public/campaigns/{campaignId}/resume

Resume a paused campaign

Parameters

Parameters of POST /api/v1/public/campaigns/{campaignId}/resume
Name	Type	Required	Description
campaignId	`string`	Required

Returns 200 with CampaignDto in data.

POST/api/v1/public/campaigns/{campaignId}/schedule

Schedule an approved campaign, optionally recurring

Parameters

Parameters of POST /api/v1/public/campaigns/{campaignId}/schedule
Name	Type	Required	Description
campaignId	`string`	Required

Request body ScheduleCampaignDto

Request body of POST /api/v1/public/campaigns/{campaignId}/schedule
Name	Type	Required	Description
scheduledAt	`string`	Required
recurrence	`object`	Optional

Returns 200 with CampaignDto in data.

POST/api/v1/public/campaigns/{campaignId}/submit

Submit a draft for approval by a member of the organization

Parameters

Parameters of POST /api/v1/public/campaigns/{campaignId}/submit
Name	Type	Required	Description
campaignId	`string`	Required

Returns 200 with CampaignDto in data.

Consent

POST/api/v1/public/consent-assertions

Record consent or withdrawals you captured, up to 500 per call

Each item is resolved and recorded on its own; the response has one result per item. A GRANTED is refused (conflict) when the contact withdrew after capturedAt. Suppressions are never lifted and are listed in blockedBy.

Request body AssertConsentDto

Request body of POST /api/v1/public/consent-assertions
Name	Type	Required	Description
assertions	ConsentAssertionDto[]	Required

Returns 200 with ConsentAssertionResultDto[] in data.

GET/api/v1/public/contacts/{contactId}/consent

A contact's consent records and the suppressions in force

Parameters

Parameters of GET /api/v1/public/contacts/{contactId}/consent
Name	Type	Required	Description
contactId	`string`	Required

Returns 200 with ContactConsentStateDto in data.

GET/api/v1/public/suppressions

Every suppression in force across the organization

Parameters

Parameters of GET /api/v1/public/suppressions
Name	Type	Required	Description
page	`number`	Optional
pageSize	`number`	Optional

Returns 200 with a page of SuppressionDto in data, with pagination.

Contacts

GET/api/v1/public/contacts

List contacts; `q` searches name, email, phone and external reference

Parameters

Parameters of GET /api/v1/public/contacts
Name	Type	Required
page	`number`	Optional
pageSize	`number`	Optional
status	`"ACTIVE" \| "ARCHIVED"`	Optional
q	`string`	Optional

Returns 200 with a page of ContactDto in data, with pagination.

POST/api/v1/public/contacts

Create a contact

Request body CustomerInputDto

Request body of POST /api/v1/public/contacts
Name	Type	Required
fullName	`string`	Required
email	`string (email)`	Optional
phone	`string`	Optional
externalRef	`string`	Optional
preferredLanguage	`string`	Optional
timeZone	`string`	Optional
tags	`string[]`	Optional
customFields	`object`	Optional
notes	`string`	Optional

Returns 201 with ContactDto in data.

GET/api/v1/public/contacts/{contactId}

Get one contact

Parameters

Parameters of GET /api/v1/public/contacts/{contactId}
Name	Type	Required	Description
contactId	`string`	Required

Returns 200 with ContactDto in data.

PATCH/api/v1/public/contacts/{contactId}

Update a contact; omitted fields are kept

Parameters

Parameters of PATCH /api/v1/public/contacts/{contactId}
Name	Type	Required	Description
contactId	`string`	Required

Request body UpdateCustomerDto

Request body of PATCH /api/v1/public/contacts/{contactId}
Name	Type	Required
fullName	`string`	Optional
email	`string (email)`	Optional
phone	`string`	Optional
externalRef	`string`	Optional
preferredLanguage	`string`	Optional
timeZone	`string`	Optional
tags	`string[]`	Optional
customFields	`object`	Optional
notes	`string`	Optional

Returns 200 with ContactDto in data.

DELETE/api/v1/public/contacts/{contactId}

Archive a contact

Archived contacts are left out of audiences and sends but keep their history. Restore with POST …/restore. To remove personal data, request erasure instead.

Parameters

Parameters of DELETE /api/v1/public/contacts/{contactId}
Name	Type	Required	Description
contactId	`string`	Required

Returns 200 with ContactDto in data.

POST/api/v1/public/contacts/{contactId}/erasure

Request erasure of a contact's personal data

Schedules anonymization after the grace period (30 days), during which a member can cancel it in the dashboard. Message history is kept without personal data.

Parameters

Parameters of POST /api/v1/public/contacts/{contactId}/erasure
Name	Type	Required	Description
contactId	`string`	Required

Returns 202 with ContactErasureDto in data.

POST/api/v1/public/contacts/{contactId}/restore

Restore an archived contact

Parameters

Parameters of POST /api/v1/public/contacts/{contactId}/restore
Name	Type	Required	Description
contactId	`string`	Required

Returns 200 with ContactDto in data.

PUT/api/v1/public/contacts/by-ref/{externalRef}

Create or update a contact by your own id

Matches by externalRef, then by email (adopting a contact that has no reference yet). Sent fields replace stored ones; omitted fields are kept. 201 when created, 200 when updated. An archived contact is updated but stays archived. Inline `consent` is recorded like POST /public/consent-assertions and needs consent:write.

Parameters

Parameters of PUT /api/v1/public/contacts/by-ref/{externalRef}
Name	Type	Required	Description
externalRef	`string`	Required

Request body UpsertContactInputDto

Request body of PUT /api/v1/public/contacts/by-ref/{externalRef}
Name	Type	Required
fullName	`string`	Optional
email	`string (email)`	Optional
phone	`string`	Optional
preferredLanguage	`string`	Optional
timeZone	`string`	Optional
tags	`string[]`	Optional
customFields	`object`	Optional
notes	`string`	Optional
consent	ConsentStatementDto[]	Optional

Returns 200 with UpsertContactDto in data.

POST/api/v1/public/contacts/imports

Import up to 10,000 contacts in the background

Rows match existing contacts by externalRef, then email. UPSERT (default) updates matches; CREATE_ONLY skips them. Rows that fail are skipped with a reason; the rest are imported.

Request body StartContactImportDto

Request body of POST /api/v1/public/contacts/imports
Name	Type	Required
rows	ContactImportRowDto[]	Required
mode	`"CREATE_ONLY" \| "UPSERT"`	Optional
attestedAcceptableUse	`boolean`	Required

Returns 202 with ContactImportDto in data.

GET/api/v1/public/contacts/imports/{importId}

An import's status, counts and skipped rows

Parameters

Parameters of GET /api/v1/public/contacts/imports/{importId}
Name	Type	Required	Description
importId	`string`	Required

Returns 200 with ContactImportDto in data.

Journeys

GET/api/v1/public/journey-enrollments/{enrollmentId}

Get an enrollment

Parameters

Parameters of GET /api/v1/public/journey-enrollments/{enrollmentId}
Name	Type	Required	Description
enrollmentId	`string`	Required

Returns 200 with JourneyEnrollmentDto in data.

POST/api/v1/public/journey-enrollments/{enrollmentId}/exit

Take a contact out of a journey

Stops the enrollment before its next step. Exiting an enrollment that already exited returns it unchanged; a completed one cannot be exited (409). Messages a step already queued are not recalled.

Parameters

Parameters of POST /api/v1/public/journey-enrollments/{enrollmentId}/exit
Name	Type	Required	Description
enrollmentId	`string`	Required

Request body ExitEnrollmentDto

Request body of POST /api/v1/public/journey-enrollments/{enrollmentId}/exit
Name	Type	Required	Description
reason	`string`	Optional

Returns 200 with JourneyEnrollmentDto in data.

GET/api/v1/public/journeys

List journeys

Parameters

Parameters of GET /api/v1/public/journeys
Name	Type	Required
page	`number`	Optional
pageSize	`number`	Optional
status	`"DRAFT" \| "PUBLISHED" \| "PAUSED" \| "ARCHIVED"`	Optional

Returns 200 with a page of JourneyDto in data, with pagination.

GET/api/v1/public/journeys/{journeyId}

Get a journey

Parameters

Parameters of GET /api/v1/public/journeys/{journeyId}
Name	Type	Required	Description
journeyId	`string`	Required

Returns 200 with JourneyDto in data.

GET/api/v1/public/journeys/{journeyId}/enrollments

List a journey’s enrollments, newest first

Parameters

Parameters of GET /api/v1/public/journeys/{journeyId}/enrollments
Name	Type	Required	Description
journeyId	`string`	Required
page	`number`	Optional
pageSize	`number`	Optional
contactId	`string`	Optional	Only this contact’s enrollments.
status	`"ACTIVE" \| "COMPLETED" \| "EXITED"`	Optional

Returns 200 with a page of JourneyEnrollmentDto in data, with pagination.

POST/api/v1/public/journeys/{journeyId}/enrollments

Enroll a contact in a journey

The journey must be PUBLISHED. Identify the contact by contactId, externalRef or email; archived contacts are not found. 201 when a new enrollment starts. 200 with the existing enrollment when the contact is already in the journey, or already finished it and the journey does not allow re-entry — safe to retry.

Parameters

Parameters of POST /api/v1/public/journeys/{journeyId}/enrollments
Name	Type	Required	Description
journeyId	`string`	Required

Request body EnrollContactDto

Request body of POST /api/v1/public/journeys/{journeyId}/enrollments
Name	Type	Required	Description
contact	ContactReferenceDto	Required

Returns 200 with EnrollContactResultDto in data.

Messages

POST/api/v1/public/messages

Send one transactional message to one contact

Request body SendMessageDto

Request body of POST /api/v1/public/messages
Name	Type	Required
to	ContactReferenceDto	Required
channelId	`string`	Required
templateId	`string`	Optional
message	`string`	Optional
reference	`string`	Optional
respectSendWindow	`boolean`	Optional

Returns 201 with MessageDto in data.

GET/api/v1/public/messages/{messageId}

Read one message's delivery status

Parameters

Parameters of GET /api/v1/public/messages/{messageId}
Name	Type	Required	Description
messageId	`string`	Required

Returns 200 with MessageDto in data.

Sandbox

GET/api/v1/public/sandbox/messages

Messages the sandbox captured instead of sending, newest first

Parameters

Parameters of GET /api/v1/public/sandbox/messages
Name	Type	Required	Description
page	`number`	Optional
pageSize	`number`	Optional

Returns 200 with a page of SandboxCapturedMessageDto in data, with pagination.

POST/api/v1/public/sandbox/messages/{messageId}/events

Simulate a delivery receipt, read, failure, reply or opt-out for a sent message

The event is handled like a real provider callback: the message status, the contact’s consent and your webhooks all change as they would live. `messageId` is a campaign message (`cmsg_…`) or single message (`cntf_…`) id.

Parameters

Parameters of POST /api/v1/public/sandbox/messages/{messageId}/events
Name	Type	Required	Description
messageId	`string`	Required

Request body TriggerSandboxEventDto

Request body of POST /api/v1/public/sandbox/messages/{messageId}/events
Name	Type	Required
type	`"delivered" \| "read" \| "failed" \| "replied" \| "opted_out"`	Required
text	`string`	Optional
failureReason	`string`	Optional

Returns 202 with SandboxEventDto in data.

Templates and channels

GET/api/v1/public/channels

The organization's channels, to choose one to send with

Parameters

Parameters of GET /api/v1/public/channels
Name	Type	Required	Description
page	`number`	Optional
pageSize	`number`	Optional

Returns 200 with a page of ChannelDto in data, with pagination.

GET/api/v1/public/templates

Message templates, APPROVED unless `status` says otherwise

Parameters

Parameters of GET /api/v1/public/templates
Name	Type	Required
page	`number`	Optional
pageSize	`number`	Optional
status	`"DRAFT" \| "APPROVED" \| "ARCHIVED"`	Optional
channelType	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM" \| "PUSH" \| "WEBHOOK" \| …`	Optional

Returns 200 with a page of TemplateDto in data, with pagination.

Tenant organizations

GET/api/v1/public/organizations

List tenant organizations, newest first

Parameters

Parameters of GET /api/v1/public/organizations
Name	Type	Required	Description
page	`number`	Optional
pageSize	`number`	Optional
status	`"ACTIVE" \| "SUSPENDED" \| "DEACTIVATED"`	Optional
externalRef	`string`	Optional	Find the tenant with this externalRef.

Returns 200 with a page of TenantOrganizationDto in data, with pagination.

POST/api/v1/public/organizations

Create a tenant organization

Partners only. 201 when created; 200 with the existing tenant when one with this externalRef already exists — safe to retry. The tenant bills through the partner, has no members, and starts one trust tier below the partner.

Request body CreateTenantOrganizationDto

Request body of POST /api/v1/public/organizations
Name	Type	Required
name	`string`	Required
externalRef	`string`	Optional
country	`string`	Optional

Returns 200 with CreateTenantOrganizationResultDto in data.

GET/api/v1/public/organizations/{organizationId}

Get a tenant organization

Parameters

Parameters of GET /api/v1/public/organizations/{organizationId}
Name	Type	Required	Description
organizationId	`string`	Required

Returns 200 with TenantOrganizationDto in data.

PATCH/api/v1/public/organizations/{organizationId}

Rename a tenant organization or change its externalRef

Parameters

Parameters of PATCH /api/v1/public/organizations/{organizationId}
Name	Type	Required	Description
organizationId	`string`	Required

Request body UpdateTenantOrganizationDto

Request body of PATCH /api/v1/public/organizations/{organizationId}
Name	Type	Required	Description
name	`string`	Optional
externalRef	`string \| null`	Optional

Returns 200 with TenantOrganizationDto in data.

POST/api/v1/public/organizations/{organizationId}/invitations

Invite someone to sign in to a tenant organization

Returns an acceptUrl for you to send to them; Senpede does not email it. Any role but owner; defaults to admin.

Parameters

Parameters of POST /api/v1/public/organizations/{organizationId}/invitations
Name	Type	Required	Description
organizationId	`string`	Required

Request body InviteTenantMemberDto

Request body of POST /api/v1/public/organizations/{organizationId}/invitations
Name	Type	Required	Description
role	`"admin" \| "manager" \| "campaign_manager" \| "analyst" \| "billing_manager" \| "viewer"`	Optional
email	`string (email)`	Required

Returns 201 with TenantInvitationDto in data.

Usage

GET/api/v1/public/usage

Allowances for the current billing period, and how much of each is used

Figures come from the same ledger sends reserve against, so they include sends in progress (`pending`). Organizations without a plan (the free trial) have no allowances listed.

Returns 200 with UsageSummaryDto in data.

GET/api/v1/public/usage/tenants

Partners only: each tenant organization's usage this billing period

How much of the partner's shared allowance each tenant used, by usage type — the breakdown behind the partner's own totals. Tenants that used nothing are left out.

Returns 200 with TenantUsageSummaryDto in data.

Webhook endpoints

GET/api/v1/public/webhook-endpoints

List webhook endpoints

Returns 200 with WebhookEndpointDto[] in data.

POST/api/v1/public/webhook-endpoints

Register an endpoint; the signing secret is returned once

Request body CreateWebhookEndpointDto

Request body of POST /api/v1/public/webhook-endpoints
Name	Type	Required
url	`string`	Required
description	`string`	Optional
eventTypes	`"message.sent" \| "message.delivered" \| "message.read" \| "message.replied" \| "message.clicked" \| "message.failed" \| …[]`	Required
includeTenantEvents	`boolean`	Optional

Returns 201 with WebhookEndpointWithSecretDto in data.

GET/api/v1/public/webhook-endpoints/{endpointId}

Get one webhook endpoint

Parameters

Parameters of GET /api/v1/public/webhook-endpoints/{endpointId}
Name	Type	Required	Description
endpointId	`string`	Required

Returns 200 with WebhookEndpointDto in data.

PATCH/api/v1/public/webhook-endpoints/{endpointId}

Change an endpoint’s URL, description, event types or enabled state

Parameters

Parameters of PATCH /api/v1/public/webhook-endpoints/{endpointId}
Name	Type	Required	Description
endpointId	`string`	Required

Request body UpdateWebhookEndpointDto

Request body of PATCH /api/v1/public/webhook-endpoints/{endpointId}
Name	Type	Required
url	`string`	Optional
description	`string`	Optional
eventTypes	`"message.sent" \| "message.delivered" \| "message.read" \| "message.replied" \| "message.clicked" \| "message.failed" \| …[]`	Optional
enabled	`boolean`	Optional
includeTenantEvents	`boolean`	Optional

Returns 200 with WebhookEndpointDto in data.

DELETE/api/v1/public/webhook-endpoints/{endpointId}

Delete an endpoint and its delivery log

Parameters

Parameters of DELETE /api/v1/public/webhook-endpoints/{endpointId}
Name	Type	Required	Description
endpointId	`string`	Required

Returns 204 and no body.

GET/api/v1/public/webhook-endpoints/{endpointId}/deliveries

An endpoint’s delivery log, optionally by status

Parameters

Parameters of GET /api/v1/public/webhook-endpoints/{endpointId}/deliveries
Name	Type	Required
endpointId	`string`	Required
page	`number`	Optional
pageSize	`number`	Optional
status	`"PENDING" \| "SUCCEEDED" \| "FAILED" \| "DEAD"`	Optional

Returns 200 with a page of WebhookDeliveryDto in data, with pagination.

POST/api/v1/public/webhook-endpoints/{endpointId}/deliveries/{deliveryId}/replay

Re-send a delivery with a fresh retry budget

Parameters

Parameters of POST /api/v1/public/webhook-endpoints/{endpointId}/deliveries/{deliveryId}/replay
Name	Type	Required	Description
endpointId	`string`	Required
deliveryId	`string`	Required

Returns 202 with WebhookDeliveryDto in data.

POST/api/v1/public/webhook-endpoints/{endpointId}/rotate-secret

Replace the signing secret; the new one is returned once

Parameters

Parameters of POST /api/v1/public/webhook-endpoints/{endpointId}/rotate-secret
Name	Type	Required	Description
endpointId	`string`	Required

Returns 200 with WebhookEndpointWithSecretDto in data.

POST/api/v1/public/webhook-endpoints/{endpointId}/test

Send a `webhook.test` event to this endpoint

Parameters

Parameters of POST /api/v1/public/webhook-endpoints/{endpointId}/test
Name	Type	Required	Description
endpointId	`string`	Required

Returns 202 with WebhookDeliveryDto in data.

OAuth

POST/api/v1/oauth/token

Get an access token (client credentials grant)

Exchange an OAuth client’s client_id and client_secret for a bearer token for /public/* routes. Send `grant_type=client_credentials`, and optionally `scope` (space-separated) to narrow the token. Authenticate with HTTP Basic or with client_id and client_secret in the body.

Request body `object`

No fields.

Returns 200 with object in data.

Schemas

The request and response shapes the operations above refer to.

ApiErrorResponse

Fields of ApiErrorResponse
Name	Type	Required	Description
error	`object`	Required

AssertConsentDto

Fields of AssertConsentDto
Name	Type	Required	Description
assertions	ConsentAssertionDto[]	Required

AudienceDto

Fields of AudienceDto
Name	Type	Required	Description
type	`"STATIC" \| "DYNAMIC"`	Required	STATIC audiences list their members; DYNAMIC ones match contacts by criteria and are read-only here.
criteria	`object \| null`	Required	Matching rules of a DYNAMIC audience; null for STATIC.
id	`string`	Required
name	`string`	Required
description	`string \| null`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required

AudienceListResponse

Fields of AudienceListResponse
Name	Type	Required	Description
data	AudienceDto[]	Required
pagination	PaginationDto	Required

AudienceMemberDto

Fields of AudienceMemberDto
Name	Type	Required
id	`string`	Required
fullName	`string`	Required
email	`string \| null`	Required
phone	`string \| null`	Required

AudienceMemberListResponse

Fields of AudienceMemberListResponse
Name	Type	Required	Description
data	AudienceMemberDto[]	Required
pagination	PaginationDto	Required

AudienceMembersAddedDto

Fields of AudienceMembersAddedDto
Name	Type	Required	Description
added	`number`	Required

AudienceMembersAddedResponse

Fields of AudienceMembersAddedResponse
Name	Type	Required	Description
data	AudienceMembersAddedDto	Required

AudienceResponse

Fields of AudienceResponse
Name	Type	Required	Description
data	AudienceDto	Required

BroadcastDto

Fields of BroadcastDto
Name	Type	Required
campaign	CampaignDto	Required
audienceId	`string`	Required
recipients	BroadcastRecipientResultDto[]	Required

BroadcastRecipientDto

Fields of BroadcastRecipientDto
Name	Type	Required
contactId	`string`	Optional
externalRef	`string`	Optional
email	`string (email)`	Optional
phone	`string`	Optional
fullName	`string`	Optional
preferredLanguage	`string`	Optional
timeZone	`string`	Optional
customFields	`object`	Optional
consent	ConsentStatementDto[]	Optional

BroadcastRecipientResultDto

Fields of BroadcastRecipientResultDto
Name	Type	Required
resolution	`"contactId" \| "externalRef" \| "email" \| "created"`	Required
index	`number`	Required
contactId	`string`	Required
consent	ConsentAssertionResultDto[]	Required

BroadcastResponse

Fields of BroadcastResponse
Name	Type	Required	Description
data	BroadcastDto	Required

CampaignDeliveryCountsDto

Fields of CampaignDeliveryCountsDto
Name	Type	Required
PENDING	`number`	Required
SENT	`number`	Required
FAILED	`number`	Required
SKIPPED	`number`	Required

CampaignDetailDto

Fields of CampaignDetailDto
Name	Type	Required	Description
type	`"MARKETING" \| "TRANSACTIONAL" \| "INFORMATIONAL" \| "OPERATIONAL" \| "CUSTOMER_SUCCESS"`	Required
sendWindowMode	`"ORGANIZATION" \| "CUSTOM" \| "NONE"`	Required
sendWindow	SendWindowInputDto \| null	Required
status	`"DRAFT" \| "PENDING_APPROVAL" \| "APPROVED" \| "SCHEDULED" \| "EXECUTING" \| "PAUSED" \| …`	Required
recurrenceRule	`object \| null`	Required	Recurrence rule when the campaign repeats; null for a one-off send.
id	`string`	Required
name	`string`	Required
description	`string \| null`	Required
audienceId	`string`	Required
channelId	`string \| null`	Required
templateId	`string \| null`	Required
message	`string`	Required
subject	`string \| null`	Required
messageHtml	`string \| null`	Required
trackLinks	`boolean`	Required
scheduledAt	`string (date-time) \| null`	Required
approvedAt	`string (date-time) \| null`	Required
startedAt	`string (date-time) \| null`	Required
pausedAt	`string (date-time) \| null`	Required
completedAt	`string (date-time) \| null`	Required
cancelledAt	`string (date-time) \| null`	Required
cycleSeq	`number`	Required
occurrenceCount	`number`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required
history	CampaignHistoryEntryDto[]	Required

CampaignDetailResponse

Fields of CampaignDetailResponse
Name	Type	Required	Description
data	CampaignDetailDto	Required

CampaignDto

Fields of CampaignDto
Name	Type	Required	Description
type	`"MARKETING" \| "TRANSACTIONAL" \| "INFORMATIONAL" \| "OPERATIONAL" \| "CUSTOMER_SUCCESS"`	Required
sendWindowMode	`"ORGANIZATION" \| "CUSTOM" \| "NONE"`	Required
sendWindow	SendWindowInputDto \| null	Required
status	`"DRAFT" \| "PENDING_APPROVAL" \| "APPROVED" \| "SCHEDULED" \| "EXECUTING" \| "PAUSED" \| …`	Required
recurrenceRule	`object \| null`	Required	Recurrence rule when the campaign repeats; null for a one-off send.
id	`string`	Required
name	`string`	Required
description	`string \| null`	Required
audienceId	`string`	Required
channelId	`string \| null`	Required
templateId	`string \| null`	Required
message	`string`	Required
subject	`string \| null`	Required
messageHtml	`string \| null`	Required
trackLinks	`boolean`	Required
scheduledAt	`string (date-time) \| null`	Required
approvedAt	`string (date-time) \| null`	Required
startedAt	`string (date-time) \| null`	Required
pausedAt	`string (date-time) \| null`	Required
completedAt	`string (date-time) \| null`	Required
cancelledAt	`string (date-time) \| null`	Required
cycleSeq	`number`	Required
occurrenceCount	`number`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required

CampaignHistoryEntryDto

Fields of CampaignHistoryEntryDto
Name	Type	Required
fromStatus	`"DRAFT" \| "PENDING_APPROVAL" \| "APPROVED" \| "SCHEDULED" \| "EXECUTING" \| "PAUSED" \| … \| null`	Required
toStatus	`"DRAFT" \| "PENDING_APPROVAL" \| "APPROVED" \| "SCHEDULED" \| "EXECUTING" \| "PAUSED" \| …`	Required
actorUserId	`string \| null`	Required
reason	`string \| null`	Required
createdAt	`string (date-time)`	Required

CampaignListResponse

Fields of CampaignListResponse
Name	Type	Required	Description
data	CampaignDto[]	Required
pagination	PaginationDto	Required

CampaignMessageDto

Fields of CampaignMessageDto
Name	Type	Required
status	`"PENDING" \| "SENT" \| "FAILED" \| "SKIPPED"`	Required
id	`string`	Required
contactId	`string`	Required
channelId	`string`	Required
detail	`string \| null`	Required
attempts	`number`	Required
sentAt	`string (date-time) \| null`	Required
deliveredAt	`string (date-time) \| null`	Required
readAt	`string (date-time) \| null`	Required
repliedAt	`string (date-time) \| null`	Required
clickedAt	`string (date-time) \| null`	Required
heldUntil	`string (date-time) \| null`	Required
createdAt	`string (date-time)`	Required

CampaignMessageListResponse

Fields of CampaignMessageListResponse
Name	Type	Required
data	CampaignMessageDto[]	Required
pagination	PaginationDto	Required
summary	CampaignMessageSummaryDto	Required

CampaignMessageResponse

Fields of CampaignMessageResponse
Name	Type	Required	Description
data	CampaignMessageDto	Required

CampaignMessageSummaryDto

Fields of CampaignMessageSummaryDto
Name	Type	Required	Description
byStatus	CampaignDeliveryCountsDto	Required
receipts	CampaignReceiptCountsDto	Required

CampaignReceiptCountsDto

Fields of CampaignReceiptCountsDto
Name	Type	Required
delivered	`number`	Required
read	`number`	Required
replied	`number`	Required
clicked	`number`	Required

CampaignResponse

Fields of CampaignResponse
Name	Type	Required	Description
data	CampaignDto	Required

CapacityEstimateDto

Fields of CapacityEstimateDto
Name	Type	Required
estimatedRecipients	`number`	Required
remainingAllowance	`number \| null`	Required
ceiling	`number \| null`	Required
sufficient	`boolean`	Required

ChannelDto

Fields of ChannelDto
Name	Type	Required
type	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM" \| "PUSH" \| "WEBHOOK" \| …`	Required
status	`"ACTIVE" \| "DISABLED" \| "MIGRATING"`	Required
id	`string`	Required
name	`string`	Required
provider	`string`	Required
healthStatus	`string`	Required
createdAt	`string (date-time)`	Required

ChannelListResponse

Fields of ChannelListResponse
Name	Type	Required	Description
data	ChannelDto[]	Required
pagination	PaginationDto	Required

ConsentAssertionDto

Fields of ConsentAssertionDto
Name	Type	Required
channel	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM" \| "PUSH" \| "WEBHOOK" \| …`	Required
purpose	`"MARKETING" \| "TRANSACTIONAL" \| "ALL"`	Required
status	`"GRANTED" \| "WITHDRAWN"`	Required
lawfulBasis	`"CONSENT" \| "CONTRACT" \| "LEGAL_OBLIGATION" \| "VITAL_INTEREST" \| "PUBLIC_TASK" \| "LEGITIMATE_INTEREST"`	Required
expiresAt	`string`	Optional
evidenceRef	`string`	Required
capturedAt	`string`	Required
contact	ContactReferenceDto	Required

ConsentAssertionResultDto

Fields of ConsentAssertionResultDto
Name	Type	Required	Description
result	`"recorded" \| "unchanged" \| "conflict" \| "not_found"`	Required	recorded: stored. unchanged: the same status and evidenceRef were already stored. conflict: not stored, the contact withdrew after capturedAt. not_found: no active contact matches.
index	`number`	Required
contactId	`string \| null`	Required
detail	`string \| null`	Required
blockedBy	ConsentBlockDto[]	Required

ConsentAssertionsResponse

Fields of ConsentAssertionsResponse
Name	Type	Required	Description
data	ConsentAssertionResultDto[]	Required

ConsentBlockDto

Fields of ConsentBlockDto
Name	Type	Required
scope	`"GLOBAL" \| "CHANNEL" \| "PURPOSE" \| "CAMPAIGN"`	Required
channel	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM" \| "PUSH" \| "WEBHOOK" \| … \| null`	Required
purpose	`"MARKETING" \| "TRANSACTIONAL" \| "ALL" \| null`	Required
source	`string`	Required
suppressedAt	`string (date-time)`	Required

ConsentRecordDto

Fields of ConsentRecordDto
Name	Type	Required
channel	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM" \| "PUSH" \| "WEBHOOK" \| …`	Required
purpose	`"MARKETING" \| "TRANSACTIONAL" \| "ALL"`	Required
status	`"GRANTED" \| "WITHDRAWN" \| "EXPIRED" \| "REVOKED" \| "UNKNOWN"`	Required
lawfulBasis	`"CONSENT" \| "CONTRACT" \| "LEGAL_OBLIGATION" \| "VITAL_INTEREST" \| "PUBLIC_TASK" \| "LEGITIMATE_INTEREST" \| null`	Required
metadata	`object \| null`	Required
id	`string`	Required
organizationId	`string`	Required
customerId	`string`	Required
source	`string`	Required
capturedByUserId	`string \| null`	Required
evidenceRef	`string \| null`	Required
grantedAt	`string (date-time) \| null`	Required
withdrawnAt	`string (date-time) \| null`	Required
expiresAt	`string (date-time) \| null`	Required
evidenceCapturedAt	`string (date-time) \| null`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required

ConsentStatementDto

Fields of ConsentStatementDto
Name	Type	Required
channel	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM" \| "PUSH" \| "WEBHOOK" \| …`	Required
purpose	`"MARKETING" \| "TRANSACTIONAL" \| "ALL"`	Required
status	`"GRANTED" \| "WITHDRAWN"`	Required
lawfulBasis	`"CONSENT" \| "CONTRACT" \| "LEGAL_OBLIGATION" \| "VITAL_INTEREST" \| "PUBLIC_TASK" \| "LEGITIMATE_INTEREST"`	Required
expiresAt	`string`	Optional
evidenceRef	`string`	Required
capturedAt	`string`	Required

ContactConsentStateDto

Fields of ContactConsentStateDto
Name	Type	Required	Description
records	ConsentRecordDto[]	Required
activeSuppressions	SuppressionDto[]	Required

ContactConsentStateResponse

Fields of ContactConsentStateResponse
Name	Type	Required	Description
data	ContactConsentStateDto	Required

ContactDto

Fields of ContactDto
Name	Type	Required
status	`"ACTIVE" \| "ARCHIVED"`	Required
customFields	`object \| null`	Required
id	`string`	Required
fullName	`string`	Required
email	`string \| null`	Required
phone	`string \| null`	Required
externalRef	`string \| null`	Required
preferredLanguage	`string \| null`	Required
timeZone	`string \| null`	Required
tags	`string[]`	Required
notes	`string \| null`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required
isSuppressed	`boolean`	Optional

ContactErasureDto

Fields of ContactErasureDto
Name	Type	Required
status	`"SCHEDULED" \| "ANONYMIZED" \| "CANCELLED"`	Required
id	`string`	Required
requestedByUserId	`string`	Required
requestedAt	`string (date-time)`	Required
effectiveAt	`string (date-time)`	Required
cancelledAt	`string (date-time) \| null`	Required
anonymizedAt	`string (date-time) \| null`	Required

ContactErasureResponse

Fields of ContactErasureResponse
Name	Type	Required	Description
data	ContactErasureDto	Required

ContactImportDto

Fields of ContactImportDto
Name	Type	Required
status	`"QUEUED" \| "RUNNING" \| "COMPLETED" \| "FAILED"`	Required
mode	`"CREATE_ONLY" \| "UPSERT"`	Required
id	`string`	Required
totalRows	`number`	Required
processedRows	`number`	Required
createdCount	`number`	Required
updatedCount	`number`	Required
skippedCount	`number`	Required
errors	ContactImportRowErrorDto[]	Required
detail	`string \| null`	Required
startedAt	`string (date-time) \| null`	Required
completedAt	`string (date-time) \| null`	Required
createdAt	`string (date-time)`	Required

ContactImportResponse

Fields of ContactImportResponse
Name	Type	Required	Description
data	ContactImportDto	Required

ContactImportRowDto

Fields of ContactImportRowDto
Name	Type	Required
fullName	`string`	Optional
email	`string (email)`	Optional
phone	`string`	Optional
externalRef	`string`	Optional
preferredLanguage	`string`	Optional
timeZone	`string`	Optional
tags	`string[]`	Optional
customFields	`object`	Optional
notes	`string`	Optional

ContactImportRowErrorDto

Fields of ContactImportRowErrorDto
Name	Type	Required
row	`number`	Required
externalRef	`string \| null`	Required
reason	`string`	Required

ContactListResponse

Fields of ContactListResponse
Name	Type	Required	Description
data	ContactDto[]	Required
pagination	PaginationDto	Required

ContactReferenceDto

Fields of ContactReferenceDto
Name	Type	Required
contactId	`string`	Optional
externalRef	`string`	Optional
email	`string (email)`	Optional

ContactResponse

Fields of ContactResponse
Name	Type	Required	Description
data	ContactDto	Required

CreateBroadcastDto

Fields of CreateBroadcastDto
Name	Type	Required
sendWindowMode	`"ORGANIZATION" \| "CUSTOM" \| "NONE"`	Optional
sendWindow	SendWindowInputDto \| null	Optional
name	`string`	Required
description	`string`	Optional
type	`"MARKETING" \| "TRANSACTIONAL" \| "INFORMATIONAL" \| "OPERATIONAL" \| "CUSTOMER_SUCCESS"`	Optional
channelId	`string`	Required
templateId	`string`	Optional
message	`string`	Required
subject	`string`	Optional
messageHtml	`string`	Optional
recipients	BroadcastRecipientDto[]	Required

CreateCampaignDto

Fields of CreateCampaignDto
Name	Type	Required
sendWindowMode	`"ORGANIZATION" \| "CUSTOM" \| "NONE"`	Optional
sendWindow	SendWindowInputDto \| null	Optional
name	`string`	Required
description	`string`	Optional
type	`"MARKETING" \| "TRANSACTIONAL" \| "INFORMATIONAL" \| "OPERATIONAL" \| "CUSTOMER_SUCCESS"`	Optional
audienceId	`string`	Required
channelId	`string`	Optional
templateId	`string`	Optional
message	`string`	Required
subject	`string`	Optional
messageHtml	`string`	Optional
trackLinks	`boolean`	Optional

CreateStaticAudienceDto

Fields of CreateStaticAudienceDto
Name	Type	Required	Description
name	`string`	Required
description	`string`	Optional

CreateTenantOrganizationDto

Fields of CreateTenantOrganizationDto
Name	Type	Required
name	`string`	Required
externalRef	`string`	Optional
country	`string`	Optional

CreateTenantOrganizationResponse

Fields of CreateTenantOrganizationResponse
Name	Type	Required	Description
data	CreateTenantOrganizationResultDto	Required

CreateTenantOrganizationResultDto

Fields of CreateTenantOrganizationResultDto
Name	Type	Required	Description
created	`boolean`	Required
organization	TenantOrganizationDto	Required

CreateWebhookEndpointDto

Fields of CreateWebhookEndpointDto
Name	Type	Required
url	`string`	Required
description	`string`	Optional
eventTypes	`"message.sent" \| "message.delivered" \| "message.read" \| "message.replied" \| "message.clicked" \| "message.failed" \| …[]`	Required
includeTenantEvents	`boolean`	Optional

CustomerInputDto

Fields of CustomerInputDto
Name	Type	Required
fullName	`string`	Required
email	`string (email)`	Optional
phone	`string`	Optional
externalRef	`string`	Optional
preferredLanguage	`string`	Optional
timeZone	`string`	Optional
tags	`string[]`	Optional
customFields	`object`	Optional
notes	`string`	Optional

EnrollContactDto

Fields of EnrollContactDto
Name	Type	Required	Description
contact	ContactReferenceDto	Required

EnrollContactResponse

Fields of EnrollContactResponse
Name	Type	Required	Description
data	EnrollContactResultDto	Required

EnrollContactResultDto

Fields of EnrollContactResultDto
Name	Type	Required	Description
created	`boolean`	Required
enrollment	JourneyEnrollmentDto	Required

ExitEnrollmentDto

Fields of ExitEnrollmentDto
Name	Type	Required	Description
reason	`string`	Optional

InviteTenantMemberDto

Fields of InviteTenantMemberDto
Name	Type	Required	Description
role	`"admin" \| "manager" \| "campaign_manager" \| "analyst" \| "billing_manager" \| "viewer"`	Optional
email	`string (email)`	Required

JourneyDto

Fields of JourneyDto
Name	Type	Required
status	`"DRAFT" \| "PUBLISHED" \| "PAUSED" \| "ARCHIVED"`	Required
id	`string`	Required
name	`string`	Required
description	`string \| null`	Required
version	`number`	Required
stepCount	`number`	Required
allowReEntry	`boolean`	Required
publishedAt	`string (date-time) \| null`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required

JourneyEnrollmentDto

Fields of JourneyEnrollmentDto
Name	Type	Required
status	`"ACTIVE" \| "COMPLETED" \| "EXITED"`	Required
id	`string`	Required
journeyId	`string`	Required
contactId	`string`	Required
currentStepIndex	`number`	Required
journeyVersion	`number`	Required
source	`string`	Required
exitReason	`string \| null`	Required
enrolledAt	`string (date-time)`	Required
completedAt	`string (date-time) \| null`	Required
exitedAt	`string (date-time) \| null`	Required

JourneyEnrollmentListResponse

Fields of JourneyEnrollmentListResponse
Name	Type	Required	Description
data	JourneyEnrollmentDto[]	Required
pagination	PaginationDto	Required

JourneyEnrollmentResponse

Fields of JourneyEnrollmentResponse
Name	Type	Required	Description
data	JourneyEnrollmentDto	Required

JourneyListResponse

Fields of JourneyListResponse
Name	Type	Required	Description
data	JourneyDto[]	Required
pagination	PaginationDto	Required

JourneyResponse

Fields of JourneyResponse
Name	Type	Required	Description
data	JourneyDto	Required

MessageDto

Fields of MessageDto
Name	Type	Required
status	`"PENDING" \| "SENT" \| "FAILED" \| "SKIPPED"`	Required
id	`string`	Required
customerId	`string`	Required
channelId	`string`	Required
templateId	`string \| null`	Required
recipientRef	`string \| null`	Required
providerMessageId	`string \| null`	Required
detail	`string \| null`	Required
attempts	`number`	Required
triggerEvent	`string`	Required
respectSendWindow	`boolean`	Required
heldUntil	`string (date-time) \| null`	Required
sentAt	`string (date-time) \| null`	Required
createdAt	`string (date-time)`	Required

MessageResponse

Fields of MessageResponse
Name	Type	Required	Description
data	MessageDto	Required

PaginationDto

Fields of PaginationDto
Name	Type	Required
page	`number`	Optional
pageSize	`number`	Optional
totalItems	`number`	Optional
totalPages	`number`	Optional
hasNextPage	`boolean`	Required
hasPreviousPage	`boolean`	Optional

PublicAddAudienceMembersDto

Fields of PublicAddAudienceMembersDto
Name	Type	Required	Description
contactIds	`string[]`	Optional
externalRefs	`string[]`	Optional

SandboxCapturedMessageDto

Fields of SandboxCapturedMessageDto
Name	Type	Required
channelType	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM"`	Required
scenario	`"delivered" \| "read" \| "failed" \| "replied" \| "opted_out" \| "no_receipt"`	Required
id	`string`	Required
organizationId	`string`	Required
channelId	`string`	Required
messageId	`string \| null`	Required
recipientRef	`string`	Required
subject	`string \| null`	Required
text	`string`	Required
providerMessageId	`string`	Required
createdAt	`string (date-time)`	Required

SandboxCapturedMessageListResponse

Fields of SandboxCapturedMessageListResponse
Name	Type	Required	Description
data	SandboxCapturedMessageDto[]	Required
pagination	PaginationDto	Required

SandboxEventDto

Fields of SandboxEventDto
Name	Type	Required	Description
type	`"delivered" \| "read" \| "failed" \| "replied" \| "opted_out"`	Required
messageId	`string`	Required

SandboxEventResponse

Fields of SandboxEventResponse
Name	Type	Required	Description
data	SandboxEventDto	Required

ScheduleCampaignDto

Fields of ScheduleCampaignDto
Name	Type	Required	Description
scheduledAt	`string`	Required
recurrence	`object`	Optional

ScheduleCampaignResponse

Fields of ScheduleCampaignResponse
Name	Type	Required	Description
data	CampaignDto	Required
capacityEstimate	CapacityEstimateDto \| null	Required

SendMessageDto

Fields of SendMessageDto
Name	Type	Required
to	ContactReferenceDto	Required
channelId	`string`	Required
templateId	`string`	Optional
message	`string`	Optional
reference	`string`	Optional
respectSendWindow	`boolean`	Optional

SendWindowInputDto

Fields of SendWindowInputDto
Name	Type	Required	Description
start	`string`	Required	Opening time, HH:mm (24-hour).
end	`string`	Required	Closing time, HH:mm. Earlier than start means the window runs past midnight.
days	`0 \| 3 \| 1 \| 2 \| 4 \| 5 \| …[]`	Required	Days the window opens, 0 (Sunday) to 6 (Saturday).
timeZone	`string`	Required	IANA time zone used when a customer's own time zone isn't known.

StartContactImportDto

Fields of StartContactImportDto
Name	Type	Required
rows	ContactImportRowDto[]	Required
mode	`"CREATE_ONLY" \| "UPSERT"`	Optional
attestedAcceptableUse	`boolean`	Required

SuppressionDto

Fields of SuppressionDto
Name	Type	Required
scope	`"GLOBAL" \| "CHANNEL" \| "PURPOSE" \| "CAMPAIGN"`	Required
channel	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM" \| "PUSH" \| "WEBHOOK" \| … \| null`	Required
purpose	`"MARKETING" \| "TRANSACTIONAL" \| "ALL" \| null`	Required
metadata	`object \| null`	Required
id	`string`	Required
organizationId	`string`	Required
customerId	`string`	Required
campaignId	`string \| null`	Required
reason	`string`	Required
source	`string`	Required
suppressedByUserId	`string \| null`	Required
suppressedAt	`string (date-time)`	Required
liftedAt	`string (date-time) \| null`	Required
liftedByUserId	`string \| null`	Required
evidenceRef	`string \| null`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required

SuppressionListResponse

Fields of SuppressionListResponse
Name	Type	Required	Description
data	SuppressionDto[]	Required
pagination	PaginationDto	Required

TemplateDto

Fields of TemplateDto
Name	Type	Required
channelType	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM" \| "PUSH" \| "WEBHOOK" \| …`	Required
status	`"DRAFT" \| "APPROVED" \| "ARCHIVED"`	Required
id	`string`	Required
name	`string`	Required
subject	`string \| null`	Required
body	`string`	Required
variables	`string[]`	Required
approvedAt	`string (date-time) \| null`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required

TemplateListResponse

Fields of TemplateListResponse
Name	Type	Required	Description
data	TemplateDto[]	Required
pagination	PaginationDto	Required

TenantInvitationDto

Fields of TenantInvitationDto
Name	Type	Required
id	`string`	Required
email	`string`	Required
role	`string`	Required
status	`string`	Required
expiresAt	`string (date-time)`	Required
acceptUrl	`string`	Required

TenantInvitationResponse

Fields of TenantInvitationResponse
Name	Type	Required	Description
data	TenantInvitationDto	Required

TenantOrganizationDto

Fields of TenantOrganizationDto
Name	Type	Required
status	`"ACTIVE" \| "SUSPENDED" \| "DEACTIVATED"`	Required
trustTier	`"NEW" \| "VERIFIED" \| "ESTABLISHED" \| "REVIEW_REQUIRED" \| "RESTRICTED" \| "SUSPENDED"`	Required
id	`string`	Required
name	`string`	Required
externalRef	`string \| null`	Required
country	`string \| null`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required

TenantOrganizationListResponse

Fields of TenantOrganizationListResponse
Name	Type	Required	Description
data	TenantOrganizationDto[]	Required
pagination	PaginationDto	Required

TenantOrganizationResponse

Fields of TenantOrganizationResponse
Name	Type	Required	Description
data	TenantOrganizationDto	Required

TenantUsageDto

Fields of TenantUsageDto
Name	Type	Required
organizationId	`string`	Required
name	`string`	Required
externalRef	`string \| null`	Required
usage	TenantUsageLineDto[]	Required

TenantUsageLineDto

Fields of TenantUsageLineDto
Name	Type	Required
usageType	`string`	Required
unit	`string`	Required
used	`number`	Required

TenantUsageSummaryDto

Fields of TenantUsageSummaryDto
Name	Type	Required
from	`string (date-time)`	Required
to	`string (date-time)`	Required
billingPeriodId	`string \| null`	Required
tenants	TenantUsageDto[]	Required

TenantUsageSummaryResponse

Fields of TenantUsageSummaryResponse
Name	Type	Required	Description
data	TenantUsageSummaryDto	Required

TransitionReasonDto

Fields of TransitionReasonDto
Name	Type	Required	Description
reason	`string`	Optional

TriggerSandboxEventDto

Fields of TriggerSandboxEventDto
Name	Type	Required
type	`"delivered" \| "read" \| "failed" \| "replied" \| "opted_out"`	Required
text	`string`	Optional
failureReason	`string`	Optional

UpdateCampaignDto

Fields of UpdateCampaignDto
Name	Type	Required
sendWindowMode	`"ORGANIZATION" \| "CUSTOM" \| "NONE"`	Optional
sendWindow	SendWindowInputDto \| null	Optional
name	`string`	Optional
description	`string`	Optional
type	`"MARKETING" \| "TRANSACTIONAL" \| "INFORMATIONAL" \| "OPERATIONAL" \| "CUSTOMER_SUCCESS"`	Optional
audienceId	`string`	Optional
channelId	`string`	Optional
templateId	`string`	Optional
message	`string`	Optional
subject	`string`	Optional
messageHtml	`string`	Optional
trackLinks	`boolean`	Optional

UpdateCustomerDto

Fields of UpdateCustomerDto
Name	Type	Required
fullName	`string`	Optional
email	`string (email)`	Optional
phone	`string`	Optional
externalRef	`string`	Optional
preferredLanguage	`string`	Optional
timeZone	`string`	Optional
tags	`string[]`	Optional
customFields	`object`	Optional
notes	`string`	Optional

UpdateTenantOrganizationDto

Fields of UpdateTenantOrganizationDto
Name	Type	Required	Description
name	`string`	Optional
externalRef	`string \| null`	Optional

UpdateWebhookEndpointDto

Fields of UpdateWebhookEndpointDto
Name	Type	Required
url	`string`	Optional
description	`string`	Optional
eventTypes	`"message.sent" \| "message.delivered" \| "message.read" \| "message.replied" \| "message.clicked" \| "message.failed" \| …[]`	Optional
enabled	`boolean`	Optional
includeTenantEvents	`boolean`	Optional

UpsertContactDto

Fields of UpsertContactDto
Name	Type	Required
created	`boolean`	Required
contact	ContactDto	Required
consent	ConsentAssertionResultDto[]	Required

UpsertContactInputDto

Fields of UpsertContactInputDto
Name	Type	Required
fullName	`string`	Optional
email	`string (email)`	Optional
phone	`string`	Optional
preferredLanguage	`string`	Optional
timeZone	`string`	Optional
tags	`string[]`	Optional
customFields	`object`	Optional
notes	`string`	Optional
consent	ConsentStatementDto[]	Optional

UpsertContactResponse

Fields of UpsertContactResponse
Name	Type	Required	Description
data	UpsertContactDto	Required

UsageAllowanceDto

Fields of UsageAllowanceDto
Name	Type	Required
usageType	`string`	Required
unit	`string`	Required
scope	UsageAllowanceScopeDto	Required
included	`number \| null`	Required
hardLimit	`number \| null`	Required
overageAllowed	`boolean`	Required
used	`number`	Required
pending	`number`	Required
remaining	`number \| null`	Required
percentUsed	`number \| null`	Required

UsageAllowanceScopeDto

Fields of UsageAllowanceScopeDto
Name	Type	Required
channelType	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM" \| "PUSH" \| "WEBHOOK" \| … \| null`	Required
ownershipMode	`"BRING_YOUR_OWN_PROVIDER" \| "SENPEDE_MANAGED" \| "DEDICATED_MANAGED" \| null`	Required
provider	`string \| null`	Required

UsageBillingPeriodDto

Fields of UsageBillingPeriodDto
Name	Type	Required
id	`string`	Required
startAt	`string (date-time)`	Required
endAt	`string (date-time)`	Required

UsagePlanDto

Fields of UsagePlanDto
Name	Type	Required	Description
code	`string`	Required
name	`string`	Required

UsageSummaryDto

Fields of UsageSummaryDto
Name	Type	Required
plan	UsagePlanDto \| null	Required
status	`string`	Required
billingPeriod	UsageBillingPeriodDto \| null	Required
allowances	UsageAllowanceDto[]	Required

UsageSummaryResponse

Fields of UsageSummaryResponse
Name	Type	Required	Description
data	UsageSummaryDto	Required

WebhookDeliveryDto

Fields of WebhookDeliveryDto
Name	Type	Required
status	`"PENDING" \| "SUCCEEDED" \| "FAILED" \| "DEAD"`	Required
id	`string`	Required
endpointId	`string`	Required
eventId	`string`	Required
eventType	`string`	Required
attempts	`number`	Required
lastStatusCode	`number \| null`	Required
lastError	`string \| null`	Required
nextAttemptAt	`string (date-time) \| null`	Required
deliveredAt	`string (date-time) \| null`	Required
createdAt	`string (date-time)`	Required

WebhookDeliveryListResponse

Fields of WebhookDeliveryListResponse
Name	Type	Required	Description
data	WebhookDeliveryDto[]	Required
pagination	PaginationDto	Required

WebhookDeliveryResponse

Fields of WebhookDeliveryResponse
Name	Type	Required	Description
data	WebhookDeliveryDto	Required

WebhookEndpointDto

Fields of WebhookEndpointDto
Name	Type	Required
eventTypes	`"message.sent" \| "message.delivered" \| "message.read" \| "message.replied" \| "message.clicked" \| "message.failed" \| …[]`	Required
id	`string`	Required
url	`string`	Required
description	`string \| null`	Required
enabled	`boolean`	Required
includeTenantEvents	`boolean`	Required
secretPrefix	`string`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required

WebhookEndpointListResponse

Fields of WebhookEndpointListResponse
Name	Type	Required	Description
data	WebhookEndpointDto[]	Required

WebhookEndpointResponse

Fields of WebhookEndpointResponse
Name	Type	Required	Description
data	WebhookEndpointDto	Required

WebhookEndpointWithSecretDto

Fields of WebhookEndpointWithSecretDto
Name	Type	Required	Description
endpoint	WebhookEndpointDto	Required
secret	`string`	Required

WebhookEndpointWithSecretResponse

Fields of WebhookEndpointWithSecretResponse
Name	Type	Required	Description
data	WebhookEndpointWithSecretDto	Required

API reference

Download openapi.json Node.js SDK Changelog

Jump to an operation

Audiences
Broadcasts
- POST Create a campaign to a supplied recipient list and submit it for approval
Campaigns
Consent
Contacts
Journeys
Messages
- POST Send one transactional message to one contact
- GET Read one message's delivery status
Sandbox
- GET Messages the sandbox captured instead of sending, newest first
- POST Simulate a delivery receipt, read, failure, reply or opt-out for a sent message
Templates and channels
- GET The organization's channels, to choose one to send with
- GET Message templates, APPROVED unless `status` says otherwise
Tenant organizations
Usage
- GET Allowances for the current billing period, and how much of each is used
- GET Partners only: each tenant organization's usage this billing period
Webhook endpoints
OAuth
- POST Get an access token (client credentials grant)

Audiences

GET/api/v1/public/audiences

List audiences

Parameters

Parameters of GET /api/v1/public/audiences
Name	Type	Required	Description
page	`number`	Optional
pageSize	`number`	Optional

Returns 200 with a page of AudienceDto in data, with pagination.

POST/api/v1/public/audiences

Create an empty STATIC audience; add contacts with …/members

Request body CreateStaticAudienceDto

Request body of POST /api/v1/public/audiences
Name	Type	Required	Description
name	`string`	Required
description	`string`	Optional

Returns 201 with AudienceDto in data.

GET/api/v1/public/audiences/{audienceId}

Get one audience

Parameters

Parameters of GET /api/v1/public/audiences/{audienceId}
Name	Type	Required	Description
audienceId	`string`	Required

Returns 200 with AudienceDto in data.

DELETE/api/v1/public/audiences/{audienceId}

Delete a STATIC audience

Parameters

Parameters of DELETE /api/v1/public/audiences/{audienceId}
Name	Type	Required	Description
audienceId	`string`	Required

Returns 204 and no body.

GET/api/v1/public/audiences/{audienceId}/members

A STATIC audience's members

Parameters

Parameters of GET /api/v1/public/audiences/{audienceId}/members
Name	Type	Required
audienceId	`string`	Required
page	`number`	Optional
pageSize	`number`	Optional

Returns 200 with a page of AudienceMemberDto in data, with pagination.

POST/api/v1/public/audiences/{audienceId}/members

Add up to 500 contacts to a STATIC audience

By Senpede id, your own externalRef, or both. Any unknown contact fails the whole call; contacts already in the audience are left as they are.

Parameters

Parameters of POST /api/v1/public/audiences/{audienceId}/members
Name	Type	Required	Description
audienceId	`string`	Required

Request body PublicAddAudienceMembersDto

Request body of POST /api/v1/public/audiences/{audienceId}/members
Name	Type	Required	Description
contactIds	`string[]`	Optional
externalRefs	`string[]`	Optional

Returns 200 with AudienceMembersAddedDto in data.

DELETE/api/v1/public/audiences/{audienceId}/members/{contactId}

Remove a contact from a STATIC audience

Parameters

Parameters of DELETE /api/v1/public/audiences/{audienceId}/members/{contactId}
Name	Type	Required	Description
audienceId	`string`	Required
contactId	`string`	Required

Returns 204 and no body.

Broadcasts

POST/api/v1/public/broadcasts

Create a campaign to a supplied recipient list and submit it for approval

Request body CreateBroadcastDto

Request body of POST /api/v1/public/broadcasts
Name	Type	Required
sendWindowMode	`"ORGANIZATION" \| "CUSTOM" \| "NONE"`	Optional
sendWindow	SendWindowInputDto \| null	Optional
name	`string`	Required
description	`string`	Optional
type	`"MARKETING" \| "TRANSACTIONAL" \| "INFORMATIONAL" \| "OPERATIONAL" \| "CUSTOMER_SUCCESS"`	Optional
channelId	`string`	Required
templateId	`string`	Optional
message	`string`	Required
subject	`string`	Optional
messageHtml	`string`	Optional
recipients	BroadcastRecipientDto[]	Required

Returns 201 with BroadcastDto in data.

Campaigns

GET/api/v1/public/campaigns

List campaigns, optionally by status

Parameters

Parameters of GET /api/v1/public/campaigns
Name	Type	Required
page	`number`	Optional
pageSize	`number`	Optional
status	`"DRAFT" \| "PENDING_APPROVAL" \| "APPROVED" \| "SCHEDULED" \| "EXECUTING" \| "PAUSED" \| …`	Optional

Returns 200 with a page of CampaignDto in data, with pagination.

POST/api/v1/public/campaigns

Create a draft campaign against an existing audience

Request body CreateCampaignDto

Request body of POST /api/v1/public/campaigns
Name	Type	Required
sendWindowMode	`"ORGANIZATION" \| "CUSTOM" \| "NONE"`	Optional
sendWindow	SendWindowInputDto \| null	Optional
name	`string`	Required
description	`string`	Optional
type	`"MARKETING" \| "TRANSACTIONAL" \| "INFORMATIONAL" \| "OPERATIONAL" \| "CUSTOMER_SUCCESS"`	Optional
audienceId	`string`	Required
channelId	`string`	Optional
templateId	`string`	Optional
message	`string`	Required
subject	`string`	Optional
messageHtml	`string`	Optional
trackLinks	`boolean`	Optional

Returns 201 with CampaignDto in data.

GET/api/v1/public/campaigns/{campaignId}

Get one campaign with its status history

Parameters

Parameters of GET /api/v1/public/campaigns/{campaignId}
Name	Type	Required	Description
campaignId	`string`	Required

Returns 200 with CampaignDetailDto in data.

PATCH/api/v1/public/campaigns/{campaignId}

Update a draft campaign

Parameters

Parameters of PATCH /api/v1/public/campaigns/{campaignId}
Name	Type	Required	Description
campaignId	`string`	Required

Request body UpdateCampaignDto

Request body of PATCH /api/v1/public/campaigns/{campaignId}
Name	Type	Required
sendWindowMode	`"ORGANIZATION" \| "CUSTOM" \| "NONE"`	Optional
sendWindow	SendWindowInputDto \| null	Optional
name	`string`	Optional
description	`string`	Optional
type	`"MARKETING" \| "TRANSACTIONAL" \| "INFORMATIONAL" \| "OPERATIONAL" \| "CUSTOMER_SUCCESS"`	Optional
audienceId	`string`	Optional
channelId	`string`	Optional
templateId	`string`	Optional
message	`string`	Optional
subject	`string`	Optional
messageHtml	`string`	Optional
trackLinks	`boolean`	Optional

Returns 200 with CampaignDto in data.

POST/api/v1/public/campaigns/{campaignId}/cancel

Cancel a campaign; pending deliveries are dropped

Parameters

Parameters of POST /api/v1/public/campaigns/{campaignId}/cancel
Name	Type	Required	Description
campaignId	`string`	Required

Request body TransitionReasonDto

Request body of POST /api/v1/public/campaigns/{campaignId}/cancel
Name	Type	Required	Description
reason	`string`	Optional

Returns 200 with CampaignDto in data.

GET/api/v1/public/campaigns/{campaignId}/messages

A campaign's messages with their delivery status, receipts, replies and clicks

Parameters

Parameters of GET /api/v1/public/campaigns/{campaignId}/messages
Name	Type	Required
campaignId	`string`	Required
page	`number`	Optional
pageSize	`number`	Optional
status	`"PENDING" \| "SENT" \| "FAILED" \| "SKIPPED"`	Optional

Returns 200 with a page of CampaignMessageDto in data, with pagination.

GET/api/v1/public/campaigns/{campaignId}/messages/{messageId}

One of a campaign's messages

Parameters

Parameters of GET /api/v1/public/campaigns/{campaignId}/messages/{messageId}
Name	Type	Required	Description
campaignId	`string`	Required
messageId	`string`	Required

Returns 200 with CampaignMessageDto in data.

POST/api/v1/public/campaigns/{campaignId}/pause

Pause an executing campaign

Parameters

Parameters of POST /api/v1/public/campaigns/{campaignId}/pause
Name	Type	Required	Description
campaignId	`string`	Required

Request body TransitionReasonDto

Request body of POST /api/v1/public/campaigns/{campaignId}/pause
Name	Type	Required	Description
reason	`string`	Optional

Returns 200 with CampaignDto in data.

POST/api/v1/public/campaigns/{campaignId}/resume

Resume a paused campaign

Parameters

Parameters of POST /api/v1/public/campaigns/{campaignId}/resume
Name	Type	Required	Description
campaignId	`string`	Required

Returns 200 with CampaignDto in data.

POST/api/v1/public/campaigns/{campaignId}/schedule

Schedule an approved campaign, optionally recurring

Parameters

Parameters of POST /api/v1/public/campaigns/{campaignId}/schedule
Name	Type	Required	Description
campaignId	`string`	Required

Request body ScheduleCampaignDto

Request body of POST /api/v1/public/campaigns/{campaignId}/schedule
Name	Type	Required	Description
scheduledAt	`string`	Required
recurrence	`object`	Optional

Returns 200 with CampaignDto in data.

POST/api/v1/public/campaigns/{campaignId}/submit

Submit a draft for approval by a member of the organization

Parameters

Parameters of POST /api/v1/public/campaigns/{campaignId}/submit
Name	Type	Required	Description
campaignId	`string`	Required

Returns 200 with CampaignDto in data.

Consent

POST/api/v1/public/consent-assertions

Record consent or withdrawals you captured, up to 500 per call

Request body AssertConsentDto

Request body of POST /api/v1/public/consent-assertions
Name	Type	Required	Description
assertions	ConsentAssertionDto[]	Required

Returns 200 with ConsentAssertionResultDto[] in data.

GET/api/v1/public/contacts/{contactId}/consent

A contact's consent records and the suppressions in force

Parameters

Parameters of GET /api/v1/public/contacts/{contactId}/consent
Name	Type	Required	Description
contactId	`string`	Required

Returns 200 with ContactConsentStateDto in data.

GET/api/v1/public/suppressions

Every suppression in force across the organization

Parameters

Parameters of GET /api/v1/public/suppressions
Name	Type	Required	Description
page	`number`	Optional
pageSize	`number`	Optional

Returns 200 with a page of SuppressionDto in data, with pagination.

Contacts

GET/api/v1/public/contacts

List contacts; `q` searches name, email, phone and external reference

Parameters

Parameters of GET /api/v1/public/contacts
Name	Type	Required
page	`number`	Optional
pageSize	`number`	Optional
status	`"ACTIVE" \| "ARCHIVED"`	Optional
q	`string`	Optional

Returns 200 with a page of ContactDto in data, with pagination.

POST/api/v1/public/contacts

Create a contact

Request body CustomerInputDto

Request body of POST /api/v1/public/contacts
Name	Type	Required
fullName	`string`	Required
email	`string (email)`	Optional
phone	`string`	Optional
externalRef	`string`	Optional
preferredLanguage	`string`	Optional
timeZone	`string`	Optional
tags	`string[]`	Optional
customFields	`object`	Optional
notes	`string`	Optional

Returns 201 with ContactDto in data.

GET/api/v1/public/contacts/{contactId}

Get one contact

Parameters

Parameters of GET /api/v1/public/contacts/{contactId}
Name	Type	Required	Description
contactId	`string`	Required

Returns 200 with ContactDto in data.

PATCH/api/v1/public/contacts/{contactId}

Update a contact; omitted fields are kept

Parameters

Parameters of PATCH /api/v1/public/contacts/{contactId}
Name	Type	Required	Description
contactId	`string`	Required

Request body UpdateCustomerDto

Request body of PATCH /api/v1/public/contacts/{contactId}
Name	Type	Required
fullName	`string`	Optional
email	`string (email)`	Optional
phone	`string`	Optional
externalRef	`string`	Optional
preferredLanguage	`string`	Optional
timeZone	`string`	Optional
tags	`string[]`	Optional
customFields	`object`	Optional
notes	`string`	Optional

Returns 200 with ContactDto in data.

DELETE/api/v1/public/contacts/{contactId}

Archive a contact

Archived contacts are left out of audiences and sends but keep their history. Restore with POST …/restore. To remove personal data, request erasure instead.

Parameters

Parameters of DELETE /api/v1/public/contacts/{contactId}
Name	Type	Required	Description
contactId	`string`	Required

Returns 200 with ContactDto in data.

POST/api/v1/public/contacts/{contactId}/erasure

Request erasure of a contact's personal data

Schedules anonymization after the grace period (30 days), during which a member can cancel it in the dashboard. Message history is kept without personal data.

Parameters

Parameters of POST /api/v1/public/contacts/{contactId}/erasure
Name	Type	Required	Description
contactId	`string`	Required

Returns 202 with ContactErasureDto in data.

POST/api/v1/public/contacts/{contactId}/restore

Restore an archived contact

Parameters

Parameters of POST /api/v1/public/contacts/{contactId}/restore
Name	Type	Required	Description
contactId	`string`	Required

Returns 200 with ContactDto in data.

PUT/api/v1/public/contacts/by-ref/{externalRef}

Create or update a contact by your own id

Parameters

Parameters of PUT /api/v1/public/contacts/by-ref/{externalRef}
Name	Type	Required	Description
externalRef	`string`	Required

Request body UpsertContactInputDto

Request body of PUT /api/v1/public/contacts/by-ref/{externalRef}
Name	Type	Required
fullName	`string`	Optional
email	`string (email)`	Optional
phone	`string`	Optional
preferredLanguage	`string`	Optional
timeZone	`string`	Optional
tags	`string[]`	Optional
customFields	`object`	Optional
notes	`string`	Optional
consent	ConsentStatementDto[]	Optional

Returns 200 with UpsertContactDto in data.

POST/api/v1/public/contacts/imports

Import up to 10,000 contacts in the background

Rows match existing contacts by externalRef, then email. UPSERT (default) updates matches; CREATE_ONLY skips them. Rows that fail are skipped with a reason; the rest are imported.

Request body StartContactImportDto

Request body of POST /api/v1/public/contacts/imports
Name	Type	Required
rows	ContactImportRowDto[]	Required
mode	`"CREATE_ONLY" \| "UPSERT"`	Optional
attestedAcceptableUse	`boolean`	Required

Returns 202 with ContactImportDto in data.

GET/api/v1/public/contacts/imports/{importId}

An import's status, counts and skipped rows

Parameters

Parameters of GET /api/v1/public/contacts/imports/{importId}
Name	Type	Required	Description
importId	`string`	Required

Returns 200 with ContactImportDto in data.

Journeys

GET/api/v1/public/journey-enrollments/{enrollmentId}

Get an enrollment

Parameters

Parameters of GET /api/v1/public/journey-enrollments/{enrollmentId}
Name	Type	Required	Description
enrollmentId	`string`	Required

Returns 200 with JourneyEnrollmentDto in data.

POST/api/v1/public/journey-enrollments/{enrollmentId}/exit

Take a contact out of a journey

Stops the enrollment before its next step. Exiting an enrollment that already exited returns it unchanged; a completed one cannot be exited (409). Messages a step already queued are not recalled.

Parameters

Parameters of POST /api/v1/public/journey-enrollments/{enrollmentId}/exit
Name	Type	Required	Description
enrollmentId	`string`	Required

Request body ExitEnrollmentDto

Request body of POST /api/v1/public/journey-enrollments/{enrollmentId}/exit
Name	Type	Required	Description
reason	`string`	Optional

Returns 200 with JourneyEnrollmentDto in data.

GET/api/v1/public/journeys

List journeys

Parameters

Parameters of GET /api/v1/public/journeys
Name	Type	Required
page	`number`	Optional
pageSize	`number`	Optional
status	`"DRAFT" \| "PUBLISHED" \| "PAUSED" \| "ARCHIVED"`	Optional

Returns 200 with a page of JourneyDto in data, with pagination.

GET/api/v1/public/journeys/{journeyId}

Get a journey

Parameters

Parameters of GET /api/v1/public/journeys/{journeyId}
Name	Type	Required	Description
journeyId	`string`	Required

Returns 200 with JourneyDto in data.

GET/api/v1/public/journeys/{journeyId}/enrollments

List a journey’s enrollments, newest first

Parameters

Parameters of GET /api/v1/public/journeys/{journeyId}/enrollments
Name	Type	Required	Description
journeyId	`string`	Required
page	`number`	Optional
pageSize	`number`	Optional
contactId	`string`	Optional	Only this contact’s enrollments.
status	`"ACTIVE" \| "COMPLETED" \| "EXITED"`	Optional

Returns 200 with a page of JourneyEnrollmentDto in data, with pagination.

POST/api/v1/public/journeys/{journeyId}/enrollments

Enroll a contact in a journey

Parameters

Parameters of POST /api/v1/public/journeys/{journeyId}/enrollments
Name	Type	Required	Description
journeyId	`string`	Required

Request body EnrollContactDto

Request body of POST /api/v1/public/journeys/{journeyId}/enrollments
Name	Type	Required	Description
contact	ContactReferenceDto	Required

Returns 200 with EnrollContactResultDto in data.

Messages

POST/api/v1/public/messages

Send one transactional message to one contact

Request body SendMessageDto

Request body of POST /api/v1/public/messages
Name	Type	Required
to	ContactReferenceDto	Required
channelId	`string`	Required
templateId	`string`	Optional
message	`string`	Optional
reference	`string`	Optional
respectSendWindow	`boolean`	Optional

Returns 201 with MessageDto in data.

GET/api/v1/public/messages/{messageId}

Read one message's delivery status

Parameters

Parameters of GET /api/v1/public/messages/{messageId}
Name	Type	Required	Description
messageId	`string`	Required

Returns 200 with MessageDto in data.

Sandbox

GET/api/v1/public/sandbox/messages

Messages the sandbox captured instead of sending, newest first

Parameters

Parameters of GET /api/v1/public/sandbox/messages
Name	Type	Required	Description
page	`number`	Optional
pageSize	`number`	Optional

Returns 200 with a page of SandboxCapturedMessageDto in data, with pagination.

POST/api/v1/public/sandbox/messages/{messageId}/events

Simulate a delivery receipt, read, failure, reply or opt-out for a sent message

Parameters

Parameters of POST /api/v1/public/sandbox/messages/{messageId}/events
Name	Type	Required	Description
messageId	`string`	Required

Request body TriggerSandboxEventDto

Request body of POST /api/v1/public/sandbox/messages/{messageId}/events
Name	Type	Required
type	`"delivered" \| "read" \| "failed" \| "replied" \| "opted_out"`	Required
text	`string`	Optional
failureReason	`string`	Optional

Returns 202 with SandboxEventDto in data.

Templates and channels

GET/api/v1/public/channels

The organization's channels, to choose one to send with

Parameters

Parameters of GET /api/v1/public/channels
Name	Type	Required	Description
page	`number`	Optional
pageSize	`number`	Optional

Returns 200 with a page of ChannelDto in data, with pagination.

GET/api/v1/public/templates

Message templates, APPROVED unless `status` says otherwise

Parameters

Parameters of GET /api/v1/public/templates
Name	Type	Required
page	`number`	Optional
pageSize	`number`	Optional
status	`"DRAFT" \| "APPROVED" \| "ARCHIVED"`	Optional
channelType	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM" \| "PUSH" \| "WEBHOOK" \| …`	Optional

Returns 200 with a page of TemplateDto in data, with pagination.

Tenant organizations

GET/api/v1/public/organizations

List tenant organizations, newest first

Parameters

Parameters of GET /api/v1/public/organizations
Name	Type	Required	Description
page	`number`	Optional
pageSize	`number`	Optional
status	`"ACTIVE" \| "SUSPENDED" \| "DEACTIVATED"`	Optional
externalRef	`string`	Optional	Find the tenant with this externalRef.

Returns 200 with a page of TenantOrganizationDto in data, with pagination.

POST/api/v1/public/organizations

Create a tenant organization

Request body CreateTenantOrganizationDto

Request body of POST /api/v1/public/organizations
Name	Type	Required
name	`string`	Required
externalRef	`string`	Optional
country	`string`	Optional

Returns 200 with CreateTenantOrganizationResultDto in data.

GET/api/v1/public/organizations/{organizationId}

Get a tenant organization

Parameters

Parameters of GET /api/v1/public/organizations/{organizationId}
Name	Type	Required	Description
organizationId	`string`	Required

Returns 200 with TenantOrganizationDto in data.

PATCH/api/v1/public/organizations/{organizationId}

Rename a tenant organization or change its externalRef

Parameters

Parameters of PATCH /api/v1/public/organizations/{organizationId}
Name	Type	Required	Description
organizationId	`string`	Required

Request body UpdateTenantOrganizationDto

Request body of PATCH /api/v1/public/organizations/{organizationId}
Name	Type	Required	Description
name	`string`	Optional
externalRef	`string \| null`	Optional

Returns 200 with TenantOrganizationDto in data.

POST/api/v1/public/organizations/{organizationId}/invitations

Invite someone to sign in to a tenant organization

Returns an acceptUrl for you to send to them; Senpede does not email it. Any role but owner; defaults to admin.

Parameters

Parameters of POST /api/v1/public/organizations/{organizationId}/invitations
Name	Type	Required	Description
organizationId	`string`	Required

Request body InviteTenantMemberDto

Request body of POST /api/v1/public/organizations/{organizationId}/invitations
Name	Type	Required	Description
role	`"admin" \| "manager" \| "campaign_manager" \| "analyst" \| "billing_manager" \| "viewer"`	Optional
email	`string (email)`	Required

Returns 201 with TenantInvitationDto in data.

Usage

GET/api/v1/public/usage

Allowances for the current billing period, and how much of each is used

Figures come from the same ledger sends reserve against, so they include sends in progress (`pending`). Organizations without a plan (the free trial) have no allowances listed.

Returns 200 with UsageSummaryDto in data.

GET/api/v1/public/usage/tenants

Partners only: each tenant organization's usage this billing period

How much of the partner's shared allowance each tenant used, by usage type — the breakdown behind the partner's own totals. Tenants that used nothing are left out.

Returns 200 with TenantUsageSummaryDto in data.

Webhook endpoints

GET/api/v1/public/webhook-endpoints

List webhook endpoints

Returns 200 with WebhookEndpointDto[] in data.

POST/api/v1/public/webhook-endpoints

Register an endpoint; the signing secret is returned once

Request body CreateWebhookEndpointDto

Request body of POST /api/v1/public/webhook-endpoints
Name	Type	Required
url	`string`	Required
description	`string`	Optional
eventTypes	`"message.sent" \| "message.delivered" \| "message.read" \| "message.replied" \| "message.clicked" \| "message.failed" \| …[]`	Required
includeTenantEvents	`boolean`	Optional

Returns 201 with WebhookEndpointWithSecretDto in data.

GET/api/v1/public/webhook-endpoints/{endpointId}

Get one webhook endpoint

Parameters

Parameters of GET /api/v1/public/webhook-endpoints/{endpointId}
Name	Type	Required	Description
endpointId	`string`	Required

Returns 200 with WebhookEndpointDto in data.

PATCH/api/v1/public/webhook-endpoints/{endpointId}

Change an endpoint’s URL, description, event types or enabled state

Parameters

Parameters of PATCH /api/v1/public/webhook-endpoints/{endpointId}
Name	Type	Required	Description
endpointId	`string`	Required

Request body UpdateWebhookEndpointDto

Request body of PATCH /api/v1/public/webhook-endpoints/{endpointId}
Name	Type	Required
url	`string`	Optional
description	`string`	Optional
eventTypes	`"message.sent" \| "message.delivered" \| "message.read" \| "message.replied" \| "message.clicked" \| "message.failed" \| …[]`	Optional
enabled	`boolean`	Optional
includeTenantEvents	`boolean`	Optional

Returns 200 with WebhookEndpointDto in data.

DELETE/api/v1/public/webhook-endpoints/{endpointId}

Delete an endpoint and its delivery log

Parameters

Parameters of DELETE /api/v1/public/webhook-endpoints/{endpointId}
Name	Type	Required	Description
endpointId	`string`	Required

Returns 204 and no body.

GET/api/v1/public/webhook-endpoints/{endpointId}/deliveries

An endpoint’s delivery log, optionally by status

Parameters

Parameters of GET /api/v1/public/webhook-endpoints/{endpointId}/deliveries
Name	Type	Required
endpointId	`string`	Required
page	`number`	Optional
pageSize	`number`	Optional
status	`"PENDING" \| "SUCCEEDED" \| "FAILED" \| "DEAD"`	Optional

Returns 200 with a page of WebhookDeliveryDto in data, with pagination.

POST/api/v1/public/webhook-endpoints/{endpointId}/deliveries/{deliveryId}/replay

Re-send a delivery with a fresh retry budget

Parameters

Parameters of POST /api/v1/public/webhook-endpoints/{endpointId}/deliveries/{deliveryId}/replay
Name	Type	Required	Description
endpointId	`string`	Required
deliveryId	`string`	Required

Returns 202 with WebhookDeliveryDto in data.

POST/api/v1/public/webhook-endpoints/{endpointId}/rotate-secret

Replace the signing secret; the new one is returned once

Parameters

Parameters of POST /api/v1/public/webhook-endpoints/{endpointId}/rotate-secret
Name	Type	Required	Description
endpointId	`string`	Required

Returns 200 with WebhookEndpointWithSecretDto in data.

POST/api/v1/public/webhook-endpoints/{endpointId}/test

Send a `webhook.test` event to this endpoint

Parameters

Parameters of POST /api/v1/public/webhook-endpoints/{endpointId}/test
Name	Type	Required	Description
endpointId	`string`	Required

Returns 202 with WebhookDeliveryDto in data.

OAuth

POST/api/v1/oauth/token

Get an access token (client credentials grant)

Request body `object`

No fields.

Returns 200 with object in data.

Schemas

The request and response shapes the operations above refer to.

ApiErrorResponse

Fields of ApiErrorResponse
Name	Type	Required	Description
error	`object`	Required

AssertConsentDto

Fields of AssertConsentDto
Name	Type	Required	Description
assertions	ConsentAssertionDto[]	Required

AudienceDto

Fields of AudienceDto
Name	Type	Required	Description
type	`"STATIC" \| "DYNAMIC"`	Required	STATIC audiences list their members; DYNAMIC ones match contacts by criteria and are read-only here.
criteria	`object \| null`	Required	Matching rules of a DYNAMIC audience; null for STATIC.
id	`string`	Required
name	`string`	Required
description	`string \| null`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required

AudienceListResponse

Fields of AudienceListResponse
Name	Type	Required	Description
data	AudienceDto[]	Required
pagination	PaginationDto	Required

AudienceMemberDto

Fields of AudienceMemberDto
Name	Type	Required
id	`string`	Required
fullName	`string`	Required
email	`string \| null`	Required
phone	`string \| null`	Required

AudienceMemberListResponse

Fields of AudienceMemberListResponse
Name	Type	Required	Description
data	AudienceMemberDto[]	Required
pagination	PaginationDto	Required

AudienceMembersAddedDto

Fields of AudienceMembersAddedDto
Name	Type	Required	Description
added	`number`	Required

AudienceMembersAddedResponse

Fields of AudienceMembersAddedResponse
Name	Type	Required	Description
data	AudienceMembersAddedDto	Required

AudienceResponse

Fields of AudienceResponse
Name	Type	Required	Description
data	AudienceDto	Required

BroadcastDto

Fields of BroadcastDto
Name	Type	Required
campaign	CampaignDto	Required
audienceId	`string`	Required
recipients	BroadcastRecipientResultDto[]	Required

BroadcastRecipientDto

Fields of BroadcastRecipientDto
Name	Type	Required
contactId	`string`	Optional
externalRef	`string`	Optional
email	`string (email)`	Optional
phone	`string`	Optional
fullName	`string`	Optional
preferredLanguage	`string`	Optional
timeZone	`string`	Optional
customFields	`object`	Optional
consent	ConsentStatementDto[]	Optional

BroadcastRecipientResultDto

Fields of BroadcastRecipientResultDto
Name	Type	Required
resolution	`"contactId" \| "externalRef" \| "email" \| "created"`	Required
index	`number`	Required
contactId	`string`	Required
consent	ConsentAssertionResultDto[]	Required

BroadcastResponse

Fields of BroadcastResponse
Name	Type	Required	Description
data	BroadcastDto	Required

CampaignDeliveryCountsDto

Fields of CampaignDeliveryCountsDto
Name	Type	Required
PENDING	`number`	Required
SENT	`number`	Required
FAILED	`number`	Required
SKIPPED	`number`	Required

CampaignDetailDto

Fields of CampaignDetailDto
Name	Type	Required	Description
type	`"MARKETING" \| "TRANSACTIONAL" \| "INFORMATIONAL" \| "OPERATIONAL" \| "CUSTOMER_SUCCESS"`	Required
sendWindowMode	`"ORGANIZATION" \| "CUSTOM" \| "NONE"`	Required
sendWindow	SendWindowInputDto \| null	Required
status	`"DRAFT" \| "PENDING_APPROVAL" \| "APPROVED" \| "SCHEDULED" \| "EXECUTING" \| "PAUSED" \| …`	Required
recurrenceRule	`object \| null`	Required	Recurrence rule when the campaign repeats; null for a one-off send.
id	`string`	Required
name	`string`	Required
description	`string \| null`	Required
audienceId	`string`	Required
channelId	`string \| null`	Required
templateId	`string \| null`	Required
message	`string`	Required
subject	`string \| null`	Required
messageHtml	`string \| null`	Required
trackLinks	`boolean`	Required
scheduledAt	`string (date-time) \| null`	Required
approvedAt	`string (date-time) \| null`	Required
startedAt	`string (date-time) \| null`	Required
pausedAt	`string (date-time) \| null`	Required
completedAt	`string (date-time) \| null`	Required
cancelledAt	`string (date-time) \| null`	Required
cycleSeq	`number`	Required
occurrenceCount	`number`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required
history	CampaignHistoryEntryDto[]	Required

CampaignDetailResponse

Fields of CampaignDetailResponse
Name	Type	Required	Description
data	CampaignDetailDto	Required

CampaignDto

Fields of CampaignDto
Name	Type	Required	Description
type	`"MARKETING" \| "TRANSACTIONAL" \| "INFORMATIONAL" \| "OPERATIONAL" \| "CUSTOMER_SUCCESS"`	Required
sendWindowMode	`"ORGANIZATION" \| "CUSTOM" \| "NONE"`	Required
sendWindow	SendWindowInputDto \| null	Required
status	`"DRAFT" \| "PENDING_APPROVAL" \| "APPROVED" \| "SCHEDULED" \| "EXECUTING" \| "PAUSED" \| …`	Required
recurrenceRule	`object \| null`	Required	Recurrence rule when the campaign repeats; null for a one-off send.
id	`string`	Required
name	`string`	Required
description	`string \| null`	Required
audienceId	`string`	Required
channelId	`string \| null`	Required
templateId	`string \| null`	Required
message	`string`	Required
subject	`string \| null`	Required
messageHtml	`string \| null`	Required
trackLinks	`boolean`	Required
scheduledAt	`string (date-time) \| null`	Required
approvedAt	`string (date-time) \| null`	Required
startedAt	`string (date-time) \| null`	Required
pausedAt	`string (date-time) \| null`	Required
completedAt	`string (date-time) \| null`	Required
cancelledAt	`string (date-time) \| null`	Required
cycleSeq	`number`	Required
occurrenceCount	`number`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required

CampaignHistoryEntryDto

Fields of CampaignHistoryEntryDto
Name	Type	Required
fromStatus	`"DRAFT" \| "PENDING_APPROVAL" \| "APPROVED" \| "SCHEDULED" \| "EXECUTING" \| "PAUSED" \| … \| null`	Required
toStatus	`"DRAFT" \| "PENDING_APPROVAL" \| "APPROVED" \| "SCHEDULED" \| "EXECUTING" \| "PAUSED" \| …`	Required
actorUserId	`string \| null`	Required
reason	`string \| null`	Required
createdAt	`string (date-time)`	Required

CampaignListResponse

Fields of CampaignListResponse
Name	Type	Required	Description
data	CampaignDto[]	Required
pagination	PaginationDto	Required

CampaignMessageDto

Fields of CampaignMessageDto
Name	Type	Required
status	`"PENDING" \| "SENT" \| "FAILED" \| "SKIPPED"`	Required
id	`string`	Required
contactId	`string`	Required
channelId	`string`	Required
detail	`string \| null`	Required
attempts	`number`	Required
sentAt	`string (date-time) \| null`	Required
deliveredAt	`string (date-time) \| null`	Required
readAt	`string (date-time) \| null`	Required
repliedAt	`string (date-time) \| null`	Required
clickedAt	`string (date-time) \| null`	Required
heldUntil	`string (date-time) \| null`	Required
createdAt	`string (date-time)`	Required

CampaignMessageListResponse

Fields of CampaignMessageListResponse
Name	Type	Required
data	CampaignMessageDto[]	Required
pagination	PaginationDto	Required
summary	CampaignMessageSummaryDto	Required

CampaignMessageResponse

Fields of CampaignMessageResponse
Name	Type	Required	Description
data	CampaignMessageDto	Required

CampaignMessageSummaryDto

Fields of CampaignMessageSummaryDto
Name	Type	Required	Description
byStatus	CampaignDeliveryCountsDto	Required
receipts	CampaignReceiptCountsDto	Required

CampaignReceiptCountsDto

Fields of CampaignReceiptCountsDto
Name	Type	Required
delivered	`number`	Required
read	`number`	Required
replied	`number`	Required
clicked	`number`	Required

CampaignResponse

Fields of CampaignResponse
Name	Type	Required	Description
data	CampaignDto	Required

CapacityEstimateDto

Fields of CapacityEstimateDto
Name	Type	Required
estimatedRecipients	`number`	Required
remainingAllowance	`number \| null`	Required
ceiling	`number \| null`	Required
sufficient	`boolean`	Required

ChannelDto

Fields of ChannelDto
Name	Type	Required
type	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM" \| "PUSH" \| "WEBHOOK" \| …`	Required
status	`"ACTIVE" \| "DISABLED" \| "MIGRATING"`	Required
id	`string`	Required
name	`string`	Required
provider	`string`	Required
healthStatus	`string`	Required
createdAt	`string (date-time)`	Required

ChannelListResponse

Fields of ChannelListResponse
Name	Type	Required	Description
data	ChannelDto[]	Required
pagination	PaginationDto	Required

ConsentAssertionDto

Fields of ConsentAssertionDto
Name	Type	Required
channel	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM" \| "PUSH" \| "WEBHOOK" \| …`	Required
purpose	`"MARKETING" \| "TRANSACTIONAL" \| "ALL"`	Required
status	`"GRANTED" \| "WITHDRAWN"`	Required
lawfulBasis	`"CONSENT" \| "CONTRACT" \| "LEGAL_OBLIGATION" \| "VITAL_INTEREST" \| "PUBLIC_TASK" \| "LEGITIMATE_INTEREST"`	Required
expiresAt	`string`	Optional
evidenceRef	`string`	Required
capturedAt	`string`	Required
contact	ContactReferenceDto	Required

ConsentAssertionResultDto

Fields of ConsentAssertionResultDto
Name	Type	Required	Description
result	`"recorded" \| "unchanged" \| "conflict" \| "not_found"`	Required	recorded: stored. unchanged: the same status and evidenceRef were already stored. conflict: not stored, the contact withdrew after capturedAt. not_found: no active contact matches.
index	`number`	Required
contactId	`string \| null`	Required
detail	`string \| null`	Required
blockedBy	ConsentBlockDto[]	Required

ConsentAssertionsResponse

Fields of ConsentAssertionsResponse
Name	Type	Required	Description
data	ConsentAssertionResultDto[]	Required

ConsentBlockDto

Fields of ConsentBlockDto
Name	Type	Required
scope	`"GLOBAL" \| "CHANNEL" \| "PURPOSE" \| "CAMPAIGN"`	Required
channel	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM" \| "PUSH" \| "WEBHOOK" \| … \| null`	Required
purpose	`"MARKETING" \| "TRANSACTIONAL" \| "ALL" \| null`	Required
source	`string`	Required
suppressedAt	`string (date-time)`	Required

ConsentRecordDto

Fields of ConsentRecordDto
Name	Type	Required
channel	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM" \| "PUSH" \| "WEBHOOK" \| …`	Required
purpose	`"MARKETING" \| "TRANSACTIONAL" \| "ALL"`	Required
status	`"GRANTED" \| "WITHDRAWN" \| "EXPIRED" \| "REVOKED" \| "UNKNOWN"`	Required
lawfulBasis	`"CONSENT" \| "CONTRACT" \| "LEGAL_OBLIGATION" \| "VITAL_INTEREST" \| "PUBLIC_TASK" \| "LEGITIMATE_INTEREST" \| null`	Required
metadata	`object \| null`	Required
id	`string`	Required
organizationId	`string`	Required
customerId	`string`	Required
source	`string`	Required
capturedByUserId	`string \| null`	Required
evidenceRef	`string \| null`	Required
grantedAt	`string (date-time) \| null`	Required
withdrawnAt	`string (date-time) \| null`	Required
expiresAt	`string (date-time) \| null`	Required
evidenceCapturedAt	`string (date-time) \| null`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required

ConsentStatementDto

Fields of ConsentStatementDto
Name	Type	Required
channel	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM" \| "PUSH" \| "WEBHOOK" \| …`	Required
purpose	`"MARKETING" \| "TRANSACTIONAL" \| "ALL"`	Required
status	`"GRANTED" \| "WITHDRAWN"`	Required
lawfulBasis	`"CONSENT" \| "CONTRACT" \| "LEGAL_OBLIGATION" \| "VITAL_INTEREST" \| "PUBLIC_TASK" \| "LEGITIMATE_INTEREST"`	Required
expiresAt	`string`	Optional
evidenceRef	`string`	Required
capturedAt	`string`	Required

ContactConsentStateDto

Fields of ContactConsentStateDto
Name	Type	Required	Description
records	ConsentRecordDto[]	Required
activeSuppressions	SuppressionDto[]	Required

ContactConsentStateResponse

Fields of ContactConsentStateResponse
Name	Type	Required	Description
data	ContactConsentStateDto	Required

ContactDto

Fields of ContactDto
Name	Type	Required
status	`"ACTIVE" \| "ARCHIVED"`	Required
customFields	`object \| null`	Required
id	`string`	Required
fullName	`string`	Required
email	`string \| null`	Required
phone	`string \| null`	Required
externalRef	`string \| null`	Required
preferredLanguage	`string \| null`	Required
timeZone	`string \| null`	Required
tags	`string[]`	Required
notes	`string \| null`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required
isSuppressed	`boolean`	Optional

ContactErasureDto

Fields of ContactErasureDto
Name	Type	Required
status	`"SCHEDULED" \| "ANONYMIZED" \| "CANCELLED"`	Required
id	`string`	Required
requestedByUserId	`string`	Required
requestedAt	`string (date-time)`	Required
effectiveAt	`string (date-time)`	Required
cancelledAt	`string (date-time) \| null`	Required
anonymizedAt	`string (date-time) \| null`	Required

ContactErasureResponse

Fields of ContactErasureResponse
Name	Type	Required	Description
data	ContactErasureDto	Required

ContactImportDto

Fields of ContactImportDto
Name	Type	Required
status	`"QUEUED" \| "RUNNING" \| "COMPLETED" \| "FAILED"`	Required
mode	`"CREATE_ONLY" \| "UPSERT"`	Required
id	`string`	Required
totalRows	`number`	Required
processedRows	`number`	Required
createdCount	`number`	Required
updatedCount	`number`	Required
skippedCount	`number`	Required
errors	ContactImportRowErrorDto[]	Required
detail	`string \| null`	Required
startedAt	`string (date-time) \| null`	Required
completedAt	`string (date-time) \| null`	Required
createdAt	`string (date-time)`	Required

ContactImportResponse

Fields of ContactImportResponse
Name	Type	Required	Description
data	ContactImportDto	Required

ContactImportRowDto

Fields of ContactImportRowDto
Name	Type	Required
fullName	`string`	Optional
email	`string (email)`	Optional
phone	`string`	Optional
externalRef	`string`	Optional
preferredLanguage	`string`	Optional
timeZone	`string`	Optional
tags	`string[]`	Optional
customFields	`object`	Optional
notes	`string`	Optional

ContactImportRowErrorDto

Fields of ContactImportRowErrorDto
Name	Type	Required
row	`number`	Required
externalRef	`string \| null`	Required
reason	`string`	Required

ContactListResponse

Fields of ContactListResponse
Name	Type	Required	Description
data	ContactDto[]	Required
pagination	PaginationDto	Required

ContactReferenceDto

Fields of ContactReferenceDto
Name	Type	Required
contactId	`string`	Optional
externalRef	`string`	Optional
email	`string (email)`	Optional

ContactResponse

Fields of ContactResponse
Name	Type	Required	Description
data	ContactDto	Required

CreateBroadcastDto

Fields of CreateBroadcastDto
Name	Type	Required
sendWindowMode	`"ORGANIZATION" \| "CUSTOM" \| "NONE"`	Optional
sendWindow	SendWindowInputDto \| null	Optional
name	`string`	Required
description	`string`	Optional
type	`"MARKETING" \| "TRANSACTIONAL" \| "INFORMATIONAL" \| "OPERATIONAL" \| "CUSTOMER_SUCCESS"`	Optional
channelId	`string`	Required
templateId	`string`	Optional
message	`string`	Required
subject	`string`	Optional
messageHtml	`string`	Optional
recipients	BroadcastRecipientDto[]	Required

CreateCampaignDto

Fields of CreateCampaignDto
Name	Type	Required
sendWindowMode	`"ORGANIZATION" \| "CUSTOM" \| "NONE"`	Optional
sendWindow	SendWindowInputDto \| null	Optional
name	`string`	Required
description	`string`	Optional
type	`"MARKETING" \| "TRANSACTIONAL" \| "INFORMATIONAL" \| "OPERATIONAL" \| "CUSTOMER_SUCCESS"`	Optional
audienceId	`string`	Required
channelId	`string`	Optional
templateId	`string`	Optional
message	`string`	Required
subject	`string`	Optional
messageHtml	`string`	Optional
trackLinks	`boolean`	Optional

CreateStaticAudienceDto

Fields of CreateStaticAudienceDto
Name	Type	Required	Description
name	`string`	Required
description	`string`	Optional

CreateTenantOrganizationDto

Fields of CreateTenantOrganizationDto
Name	Type	Required
name	`string`	Required
externalRef	`string`	Optional
country	`string`	Optional

CreateTenantOrganizationResponse

Fields of CreateTenantOrganizationResponse
Name	Type	Required	Description
data	CreateTenantOrganizationResultDto	Required

CreateTenantOrganizationResultDto

Fields of CreateTenantOrganizationResultDto
Name	Type	Required	Description
created	`boolean`	Required
organization	TenantOrganizationDto	Required

CreateWebhookEndpointDto

Fields of CreateWebhookEndpointDto
Name	Type	Required
url	`string`	Required
description	`string`	Optional
eventTypes	`"message.sent" \| "message.delivered" \| "message.read" \| "message.replied" \| "message.clicked" \| "message.failed" \| …[]`	Required
includeTenantEvents	`boolean`	Optional

CustomerInputDto

Fields of CustomerInputDto
Name	Type	Required
fullName	`string`	Required
email	`string (email)`	Optional
phone	`string`	Optional
externalRef	`string`	Optional
preferredLanguage	`string`	Optional
timeZone	`string`	Optional
tags	`string[]`	Optional
customFields	`object`	Optional
notes	`string`	Optional

EnrollContactDto

Fields of EnrollContactDto
Name	Type	Required	Description
contact	ContactReferenceDto	Required

EnrollContactResponse

Fields of EnrollContactResponse
Name	Type	Required	Description
data	EnrollContactResultDto	Required

EnrollContactResultDto

Fields of EnrollContactResultDto
Name	Type	Required	Description
created	`boolean`	Required
enrollment	JourneyEnrollmentDto	Required

ExitEnrollmentDto

Fields of ExitEnrollmentDto
Name	Type	Required	Description
reason	`string`	Optional

InviteTenantMemberDto

Fields of InviteTenantMemberDto
Name	Type	Required	Description
role	`"admin" \| "manager" \| "campaign_manager" \| "analyst" \| "billing_manager" \| "viewer"`	Optional
email	`string (email)`	Required

JourneyDto

Fields of JourneyDto
Name	Type	Required
status	`"DRAFT" \| "PUBLISHED" \| "PAUSED" \| "ARCHIVED"`	Required
id	`string`	Required
name	`string`	Required
description	`string \| null`	Required
version	`number`	Required
stepCount	`number`	Required
allowReEntry	`boolean`	Required
publishedAt	`string (date-time) \| null`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required

JourneyEnrollmentDto

Fields of JourneyEnrollmentDto
Name	Type	Required
status	`"ACTIVE" \| "COMPLETED" \| "EXITED"`	Required
id	`string`	Required
journeyId	`string`	Required
contactId	`string`	Required
currentStepIndex	`number`	Required
journeyVersion	`number`	Required
source	`string`	Required
exitReason	`string \| null`	Required
enrolledAt	`string (date-time)`	Required
completedAt	`string (date-time) \| null`	Required
exitedAt	`string (date-time) \| null`	Required

JourneyEnrollmentListResponse

Fields of JourneyEnrollmentListResponse
Name	Type	Required	Description
data	JourneyEnrollmentDto[]	Required
pagination	PaginationDto	Required

JourneyEnrollmentResponse

Fields of JourneyEnrollmentResponse
Name	Type	Required	Description
data	JourneyEnrollmentDto	Required

JourneyListResponse

Fields of JourneyListResponse
Name	Type	Required	Description
data	JourneyDto[]	Required
pagination	PaginationDto	Required

JourneyResponse

Fields of JourneyResponse
Name	Type	Required	Description
data	JourneyDto	Required

MessageDto

Fields of MessageDto
Name	Type	Required
status	`"PENDING" \| "SENT" \| "FAILED" \| "SKIPPED"`	Required
id	`string`	Required
customerId	`string`	Required
channelId	`string`	Required
templateId	`string \| null`	Required
recipientRef	`string \| null`	Required
providerMessageId	`string \| null`	Required
detail	`string \| null`	Required
attempts	`number`	Required
triggerEvent	`string`	Required
respectSendWindow	`boolean`	Required
heldUntil	`string (date-time) \| null`	Required
sentAt	`string (date-time) \| null`	Required
createdAt	`string (date-time)`	Required

MessageResponse

Fields of MessageResponse
Name	Type	Required	Description
data	MessageDto	Required

PaginationDto

Fields of PaginationDto
Name	Type	Required
page	`number`	Optional
pageSize	`number`	Optional
totalItems	`number`	Optional
totalPages	`number`	Optional
hasNextPage	`boolean`	Required
hasPreviousPage	`boolean`	Optional

PublicAddAudienceMembersDto

Fields of PublicAddAudienceMembersDto
Name	Type	Required	Description
contactIds	`string[]`	Optional
externalRefs	`string[]`	Optional

SandboxCapturedMessageDto

Fields of SandboxCapturedMessageDto
Name	Type	Required
channelType	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM"`	Required
scenario	`"delivered" \| "read" \| "failed" \| "replied" \| "opted_out" \| "no_receipt"`	Required
id	`string`	Required
organizationId	`string`	Required
channelId	`string`	Required
messageId	`string \| null`	Required
recipientRef	`string`	Required
subject	`string \| null`	Required
text	`string`	Required
providerMessageId	`string`	Required
createdAt	`string (date-time)`	Required

SandboxCapturedMessageListResponse

Fields of SandboxCapturedMessageListResponse
Name	Type	Required	Description
data	SandboxCapturedMessageDto[]	Required
pagination	PaginationDto	Required

SandboxEventDto

Fields of SandboxEventDto
Name	Type	Required	Description
type	`"delivered" \| "read" \| "failed" \| "replied" \| "opted_out"`	Required
messageId	`string`	Required

SandboxEventResponse

Fields of SandboxEventResponse
Name	Type	Required	Description
data	SandboxEventDto	Required

ScheduleCampaignDto

Fields of ScheduleCampaignDto
Name	Type	Required	Description
scheduledAt	`string`	Required
recurrence	`object`	Optional

ScheduleCampaignResponse

Fields of ScheduleCampaignResponse
Name	Type	Required	Description
data	CampaignDto	Required
capacityEstimate	CapacityEstimateDto \| null	Required

SendMessageDto

Fields of SendMessageDto
Name	Type	Required
to	ContactReferenceDto	Required
channelId	`string`	Required
templateId	`string`	Optional
message	`string`	Optional
reference	`string`	Optional
respectSendWindow	`boolean`	Optional

SendWindowInputDto

Fields of SendWindowInputDto
Name	Type	Required	Description
start	`string`	Required	Opening time, HH:mm (24-hour).
end	`string`	Required	Closing time, HH:mm. Earlier than start means the window runs past midnight.
days	`0 \| 3 \| 1 \| 2 \| 4 \| 5 \| …[]`	Required	Days the window opens, 0 (Sunday) to 6 (Saturday).
timeZone	`string`	Required	IANA time zone used when a customer's own time zone isn't known.

StartContactImportDto

Fields of StartContactImportDto
Name	Type	Required
rows	ContactImportRowDto[]	Required
mode	`"CREATE_ONLY" \| "UPSERT"`	Optional
attestedAcceptableUse	`boolean`	Required

SuppressionDto

Fields of SuppressionDto
Name	Type	Required
scope	`"GLOBAL" \| "CHANNEL" \| "PURPOSE" \| "CAMPAIGN"`	Required
channel	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM" \| "PUSH" \| "WEBHOOK" \| … \| null`	Required
purpose	`"MARKETING" \| "TRANSACTIONAL" \| "ALL" \| null`	Required
metadata	`object \| null`	Required
id	`string`	Required
organizationId	`string`	Required
customerId	`string`	Required
campaignId	`string \| null`	Required
reason	`string`	Required
source	`string`	Required
suppressedByUserId	`string \| null`	Required
suppressedAt	`string (date-time)`	Required
liftedAt	`string (date-time) \| null`	Required
liftedByUserId	`string \| null`	Required
evidenceRef	`string \| null`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required

SuppressionListResponse

Fields of SuppressionListResponse
Name	Type	Required	Description
data	SuppressionDto[]	Required
pagination	PaginationDto	Required

TemplateDto

Fields of TemplateDto
Name	Type	Required
channelType	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM" \| "PUSH" \| "WEBHOOK" \| …`	Required
status	`"DRAFT" \| "APPROVED" \| "ARCHIVED"`	Required
id	`string`	Required
name	`string`	Required
subject	`string \| null`	Required
body	`string`	Required
variables	`string[]`	Required
approvedAt	`string (date-time) \| null`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required

TemplateListResponse

Fields of TemplateListResponse
Name	Type	Required	Description
data	TemplateDto[]	Required
pagination	PaginationDto	Required

TenantInvitationDto

Fields of TenantInvitationDto
Name	Type	Required
id	`string`	Required
email	`string`	Required
role	`string`	Required
status	`string`	Required
expiresAt	`string (date-time)`	Required
acceptUrl	`string`	Required

TenantInvitationResponse

Fields of TenantInvitationResponse
Name	Type	Required	Description
data	TenantInvitationDto	Required

TenantOrganizationDto

Fields of TenantOrganizationDto
Name	Type	Required
status	`"ACTIVE" \| "SUSPENDED" \| "DEACTIVATED"`	Required
trustTier	`"NEW" \| "VERIFIED" \| "ESTABLISHED" \| "REVIEW_REQUIRED" \| "RESTRICTED" \| "SUSPENDED"`	Required
id	`string`	Required
name	`string`	Required
externalRef	`string \| null`	Required
country	`string \| null`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required

TenantOrganizationListResponse

Fields of TenantOrganizationListResponse
Name	Type	Required	Description
data	TenantOrganizationDto[]	Required
pagination	PaginationDto	Required

TenantOrganizationResponse

Fields of TenantOrganizationResponse
Name	Type	Required	Description
data	TenantOrganizationDto	Required

TenantUsageDto

Fields of TenantUsageDto
Name	Type	Required
organizationId	`string`	Required
name	`string`	Required
externalRef	`string \| null`	Required
usage	TenantUsageLineDto[]	Required

TenantUsageLineDto

Fields of TenantUsageLineDto
Name	Type	Required
usageType	`string`	Required
unit	`string`	Required
used	`number`	Required

TenantUsageSummaryDto

Fields of TenantUsageSummaryDto
Name	Type	Required
from	`string (date-time)`	Required
to	`string (date-time)`	Required
billingPeriodId	`string \| null`	Required
tenants	TenantUsageDto[]	Required

TenantUsageSummaryResponse

Fields of TenantUsageSummaryResponse
Name	Type	Required	Description
data	TenantUsageSummaryDto	Required

TransitionReasonDto

Fields of TransitionReasonDto
Name	Type	Required	Description
reason	`string`	Optional

TriggerSandboxEventDto

Fields of TriggerSandboxEventDto
Name	Type	Required
type	`"delivered" \| "read" \| "failed" \| "replied" \| "opted_out"`	Required
text	`string`	Optional
failureReason	`string`	Optional

UpdateCampaignDto

Fields of UpdateCampaignDto
Name	Type	Required
sendWindowMode	`"ORGANIZATION" \| "CUSTOM" \| "NONE"`	Optional
sendWindow	SendWindowInputDto \| null	Optional
name	`string`	Optional
description	`string`	Optional
type	`"MARKETING" \| "TRANSACTIONAL" \| "INFORMATIONAL" \| "OPERATIONAL" \| "CUSTOMER_SUCCESS"`	Optional
audienceId	`string`	Optional
channelId	`string`	Optional
templateId	`string`	Optional
message	`string`	Optional
subject	`string`	Optional
messageHtml	`string`	Optional
trackLinks	`boolean`	Optional

UpdateCustomerDto

Fields of UpdateCustomerDto
Name	Type	Required
fullName	`string`	Optional
email	`string (email)`	Optional
phone	`string`	Optional
externalRef	`string`	Optional
preferredLanguage	`string`	Optional
timeZone	`string`	Optional
tags	`string[]`	Optional
customFields	`object`	Optional
notes	`string`	Optional

UpdateTenantOrganizationDto

Fields of UpdateTenantOrganizationDto
Name	Type	Required	Description
name	`string`	Optional
externalRef	`string \| null`	Optional

UpdateWebhookEndpointDto

Fields of UpdateWebhookEndpointDto
Name	Type	Required
url	`string`	Optional
description	`string`	Optional
eventTypes	`"message.sent" \| "message.delivered" \| "message.read" \| "message.replied" \| "message.clicked" \| "message.failed" \| …[]`	Optional
enabled	`boolean`	Optional
includeTenantEvents	`boolean`	Optional

UpsertContactDto

Fields of UpsertContactDto
Name	Type	Required
created	`boolean`	Required
contact	ContactDto	Required
consent	ConsentAssertionResultDto[]	Required

UpsertContactInputDto

Fields of UpsertContactInputDto
Name	Type	Required
fullName	`string`	Optional
email	`string (email)`	Optional
phone	`string`	Optional
preferredLanguage	`string`	Optional
timeZone	`string`	Optional
tags	`string[]`	Optional
customFields	`object`	Optional
notes	`string`	Optional
consent	ConsentStatementDto[]	Optional

UpsertContactResponse

Fields of UpsertContactResponse
Name	Type	Required	Description
data	UpsertContactDto	Required

UsageAllowanceDto

Fields of UsageAllowanceDto
Name	Type	Required
usageType	`string`	Required
unit	`string`	Required
scope	UsageAllowanceScopeDto	Required
included	`number \| null`	Required
hardLimit	`number \| null`	Required
overageAllowed	`boolean`	Required
used	`number`	Required
pending	`number`	Required
remaining	`number \| null`	Required
percentUsed	`number \| null`	Required

UsageAllowanceScopeDto

Fields of UsageAllowanceScopeDto
Name	Type	Required
channelType	`"SMS" \| "EMAIL" \| "WHATSAPP" \| "TELEGRAM" \| "PUSH" \| "WEBHOOK" \| … \| null`	Required
ownershipMode	`"BRING_YOUR_OWN_PROVIDER" \| "SENPEDE_MANAGED" \| "DEDICATED_MANAGED" \| null`	Required
provider	`string \| null`	Required

UsageBillingPeriodDto

Fields of UsageBillingPeriodDto
Name	Type	Required
id	`string`	Required
startAt	`string (date-time)`	Required
endAt	`string (date-time)`	Required

UsagePlanDto

Fields of UsagePlanDto
Name	Type	Required	Description
code	`string`	Required
name	`string`	Required

UsageSummaryDto

Fields of UsageSummaryDto
Name	Type	Required
plan	UsagePlanDto \| null	Required
status	`string`	Required
billingPeriod	UsageBillingPeriodDto \| null	Required
allowances	UsageAllowanceDto[]	Required

UsageSummaryResponse

Fields of UsageSummaryResponse
Name	Type	Required	Description
data	UsageSummaryDto	Required

WebhookDeliveryDto

Fields of WebhookDeliveryDto
Name	Type	Required
status	`"PENDING" \| "SUCCEEDED" \| "FAILED" \| "DEAD"`	Required
id	`string`	Required
endpointId	`string`	Required
eventId	`string`	Required
eventType	`string`	Required
attempts	`number`	Required
lastStatusCode	`number \| null`	Required
lastError	`string \| null`	Required
nextAttemptAt	`string (date-time) \| null`	Required
deliveredAt	`string (date-time) \| null`	Required
createdAt	`string (date-time)`	Required

WebhookDeliveryListResponse

Fields of WebhookDeliveryListResponse
Name	Type	Required	Description
data	WebhookDeliveryDto[]	Required
pagination	PaginationDto	Required

WebhookDeliveryResponse

Fields of WebhookDeliveryResponse
Name	Type	Required	Description
data	WebhookDeliveryDto	Required

WebhookEndpointDto

Fields of WebhookEndpointDto
Name	Type	Required
eventTypes	`"message.sent" \| "message.delivered" \| "message.read" \| "message.replied" \| "message.clicked" \| "message.failed" \| …[]`	Required
id	`string`	Required
url	`string`	Required
description	`string \| null`	Required
enabled	`boolean`	Required
includeTenantEvents	`boolean`	Required
secretPrefix	`string`	Required
createdAt	`string (date-time)`	Required
updatedAt	`string (date-time)`	Required

WebhookEndpointListResponse

Fields of WebhookEndpointListResponse
Name	Type	Required	Description
data	WebhookEndpointDto[]	Required

WebhookEndpointResponse

Fields of WebhookEndpointResponse
Name	Type	Required	Description
data	WebhookEndpointDto	Required

WebhookEndpointWithSecretDto

Fields of WebhookEndpointWithSecretDto
Name	Type	Required	Description
endpoint	WebhookEndpointDto	Required
secret	`string`	Required

WebhookEndpointWithSecretResponse

Fields of WebhookEndpointWithSecretResponse
Name	Type	Required	Description
data	WebhookEndpointWithSecretDto	Required