api.md

Shared

Types:

• MessageTypeBooleanField
• MessageTypeButtonField
• MessageTypeImageField
• MessageTypeJsonField
• MessageTypeMarkdownField
• MessageTypeMultiSelectField
• MessageTypeSelectField
• MessageTypeTextareaField
• MessageTypeURLField
• PageInfo

Templates

Types:

• ChatTemplate
• EmailTemplate
• InAppFeedTemplate
• PushTemplate
• RequestTemplate
• SMSTemplate
• WebhookTemplate

EmailLayouts

Types:

• EmailLayout
• EmailLayoutUpsertResponse
• EmailLayoutValidateResponse

Methods:

• client.emailLayouts.retrieve(emailLayoutKey, { ...params }) -> EmailLayout
• client.emailLayouts.list({ ...params }) -> EmailLayoutsEntriesCursor
• client.emailLayouts.upsert(emailLayoutKey, { ...params }) -> EmailLayoutUpsertResponse
• client.emailLayouts.validate(emailLayoutKey, { ...params }) -> EmailLayoutValidateResponse

Commits

Types:

• Commit
• CommitCommitAllResponse
• CommitPromoteAllResponse
• CommitPromoteOneResponse

Methods:

• client.commits.retrieve(id) -> Commit
• client.commits.list({ ...params }) -> CommitsEntriesCursor
• client.commits.commitAll({ ...params }) -> CommitCommitAllResponse
• client.commits.promoteAll({ ...params }) -> CommitPromoteAllResponse
• client.commits.promoteOne(id) -> CommitPromoteOneResponse

Partials

Types:

• Partial
• PartialUpsertResponse
• PartialValidateResponse

Methods:

• client.partials.retrieve(partialKey, { ...params }) -> Partial
• client.partials.list({ ...params }) -> PartialsEntriesCursor
• client.partials.upsert(partialKey, { ...params }) -> PartialUpsertResponse
• client.partials.validate(partialKey, { ...params }) -> PartialValidateResponse

Translations

Types:

• Translation
• TranslationRetrieveResponse
• TranslationUpsertResponse
• TranslationValidateResponse

Methods:

• client.translations.retrieve(localeCode, { ...params }) -> TranslationRetrieveResponse
• client.translations.list({ ...params }) -> TranslationsEntriesCursor
• client.translations.upsert(localeCode, { ...params }) -> TranslationUpsertResponse
• client.translations.validate(localeCode, { ...params }) -> TranslationValidateResponse

Workflows

Types:

• Condition
• ConditionGroup
• Duration
• SendWindow
• Workflow
• WorkflowAIAgentStep
• WorkflowBatchStep
• WorkflowBranchStep
• WorkflowChatStep
• WorkflowDelayStep
• WorkflowEmailStep
• WorkflowFetchStep
• WorkflowInAppFeedStep
• WorkflowPushStep
• WorkflowRandomCohortStep
• WorkflowSMSStep
• WorkflowStep
• WorkflowThrottleStep
• WorkflowTriggerWorkflowStep
• WorkflowUpdateDataStep
• WorkflowUpdateObjectStep
• WorkflowUpdateTenantStep
• WorkflowUpdateUserStep
• WorkflowWebhookStep
• WorkflowRetrieveResponse
• WorkflowActivateResponse
• WorkflowRunResponse
• WorkflowUpsertResponse
• WorkflowValidateResponse

Methods:

• client.workflows.retrieve(workflowKey, { ...params }) -> WorkflowRetrieveResponse
• client.workflows.list({ ...params }) -> WorkflowsEntriesCursor
• client.workflows.activate(workflowKey, { ...params }) -> WorkflowActivateResponse
• client.workflows.run(workflowKey, { ...params }) -> WorkflowRunResponse
• client.workflows.upsert(workflowKey, { ...params }) -> WorkflowUpsertResponse
• client.workflows.validate(workflowKey, { ...params }) -> WorkflowValidateResponse

Steps

Types:

• StepPreviewTemplateResponse

Methods:

• client.workflows.steps.previewTemplate(stepRef, { ...params }) -> StepPreviewTemplateResponse

MessageTypes

Types:

• MessageType
• MessageTypeTextField
• MessageTypeVariant
• MessageTypeUpsertResponse
• MessageTypeValidateResponse

Methods:

• client.messageTypes.retrieve(messageTypeKey, { ...params }) -> MessageType
• client.messageTypes.list({ ...params }) -> MessageTypesEntriesCursor
• client.messageTypes.upsert(messageTypeKey, { ...params }) -> MessageTypeUpsertResponse
• client.messageTypes.validate(messageTypeKey, { ...params }) -> MessageTypeValidateResponse

Auth

Types:

• AuthVerifyResponse

Methods:

• client.auth.verify() -> AuthVerifyResponse

APIKeys

Types:

• APIKeyExchangeResponse

Methods:

• client.apiKeys.exchange({ ...params }) -> APIKeyExchangeResponse

ChannelGroups

Types:

• ChannelGroup
• ChannelGroupRule
• ChannelGroupUpsertResponse

Methods:

• client.channelGroups.retrieve(channelGroupKey) -> ChannelGroup
• client.channelGroups.list({ ...params }) -> ChannelGroupsEntriesCursor
• client.channelGroups.delete(channelGroupKey) -> void
• client.channelGroups.upsert(channelGroupKey, { ...params }) -> ChannelGroupUpsertResponse

Channels

Types:

• Channel
• ChannelEnvironmentSettings
• ChatChannelSettings
• EmailChannelSettings
• InAppFeedChannelSettings
• PushChannelSettings
• SMSChannelSettings

Methods:

• client.channels.retrieve(channelKey) -> Channel
• client.channels.list({ ...params }) -> ChannelsEntriesCursor

Members

Types:

• Member
• MemberUser

Methods:

• client.members.retrieve(id) -> Member
• client.members.list({ ...params }) -> MembersEntriesCursor
• client.members.delete(id) -> void

Environments

Types:

• Environment

Methods:

• client.environments.retrieve(environmentSlug) -> Environment
• client.environments.list({ ...params }) -> EnvironmentsEntriesCursor

Variables

Types:

• Variable

Methods:

• client.variables.retrieve(key) -> Variable
• client.variables.list({ ...params }) -> VariablesEntriesCursor

Guides

Types:

• Guide
• GuideActivationURLPattern
• GuideStep
• GuideActivateResponse
• GuideArchiveResponse
• GuideUpsertResponse
• GuideValidateResponse

Methods:

• client.guides.retrieve(guideKey, { ...params }) -> Guide
• client.guides.list({ ...params }) -> GuidesEntriesCursor
• client.guides.activate(guideKey, { ...params }) -> GuideActivateResponse
• client.guides.archive(guideKey) -> GuideArchiveResponse
• client.guides.upsert(guideKey, { ...params }) -> GuideUpsertResponse
• client.guides.validate(guideKey, { ...params }) -> GuideValidateResponse

Branches

Types:

• Branch

Methods:

• client.branches.create(branchSlug, { ...params }) -> Branch
• client.branches.retrieve(branchSlug, { ...params }) -> Branch
• client.branches.list({ ...params }) -> BranchesEntriesCursor
• client.branches.delete(branchSlug, { ...params }) -> void

Broadcasts

Types:

• Broadcast
• BroadcastRequest
• BroadcastCancelResponse
• BroadcastSendResponse
• BroadcastUpsertResponse
• BroadcastValidateResponse

Methods:

• client.broadcasts.retrieve(broadcastKey, { ...params }) -> Broadcast
• client.broadcasts.list({ ...params }) -> BroadcastsEntriesCursor
• client.broadcasts.cancel(broadcastKey, { ...params }) -> BroadcastCancelResponse
• client.broadcasts.send(broadcastKey, { ...params }) -> BroadcastSendResponse
• client.broadcasts.upsert(broadcastKey, { ...params }) -> BroadcastUpsertResponse
• client.broadcasts.validate(broadcastKey, { ...params }) -> BroadcastValidateResponse

Audiences

Types:

• Audience
• AudienceCondition
• DynamicAudience
• StaticAudience
• AudienceArchiveResponse
• AudienceUpsertResponse
• AudienceValidateResponse

Methods:

• client.audiences.retrieve(audienceKey, { ...params }) -> Audience
• client.audiences.list({ ...params }) -> AudiencesEntriesCursor
• client.audiences.archive(audienceKey, { ...params }) -> AudienceArchiveResponse
• client.audiences.upsert(audienceKey, { ...params }) -> AudienceUpsertResponse
• client.audiences.validate(audienceKey, { ...params }) -> AudienceValidateResponse