# mailerpath-docs

> Documentation and guides for this template—workspace setup, product how-tos, and support.

## Docs

- [Create client API key](https://docs.mailerpath.com/api-reference/api-keys/create-client-api-key.md): Create an API key for the authenticated dashboard user.
- [Delete client API key](https://docs.mailerpath.com/api-reference/api-keys/delete-client-api-key.md): Revoke and delete the API key for the authenticated dashboard user.
- [List client API keys](https://docs.mailerpath.com/api-reference/api-keys/list-client-api-keys.md): List API key metadata for the authenticated dashboard user.
- [Rotate client API key](https://docs.mailerpath.com/api-reference/api-keys/rotate-client-api-key.md): Rotate the API key for the authenticated dashboard user.
- [Update client API key status](https://docs.mailerpath.com/api-reference/api-keys/update-client-api-key-status.md): Enable or disable the API key without deleting it.
- [Get my client settings](https://docs.mailerpath.com/api-reference/client-settings/get-my-client-settings.md): Returns client settings for the authenticated client.
- [Update my client settings (upsert)](https://docs.mailerpath.com/api-reference/client-settings/update-my-client-settings-upsert.md): Partially updates client settings for the authenticated client. If missing, creates a new settings row.
- [Bulk upsert contacts](https://docs.mailerpath.com/api-reference/contacts/bulk-upsert-contacts.md): Insert or update contacts in one request, up to the configured bulk import limit (default 1000). Matches on (client_id, email).
- [Bulk upsert contacts from CSV](https://docs.mailerpath.com/api-reference/contacts/bulk-upsert-contacts-from-csv.md): Insert or update contacts from a CSV upload, up to the configured bulk import limit (default 1000). Rows are processed independently and reuse the same bulk upsert rules as the JSON endpoint. Source is always set to import.
- [Create a contact](https://docs.mailerpath.com/api-reference/contacts/create-a-contact.md): Create a new contact owned by the authenticated client. Email must be unique per client.
- [Delete a contact](https://docs.mailerpath.com/api-reference/contacts/delete-a-contact.md): Soft-delete a contact owned by the authenticated client.
- [Get a single contact](https://docs.mailerpath.com/api-reference/contacts/get-a-single-contact.md): Return a contact owned by the authenticated client.
- [Get contact journey timeline](https://docs.mailerpath.com/api-reference/contacts/get-contact-journey-timeline.md): Return an ordered timeline of events, tag assignments/removals, and workflow executions for a contact owned by the authenticated client.
- [List my contacts](https://docs.mailerpath.com/api-reference/contacts/list-my-contacts.md): Return contacts owned by the authenticated client, with optional search/filter.
- [Update a contact](https://docs.mailerpath.com/api-reference/contacts/update-a-contact.md): Update fields of a contact owned by the authenticated client.
- [Update contact subscription status](https://docs.mailerpath.com/api-reference/contacts/update-contact-subscription-status.md): Subscribe or unsubscribe a contact owned by the authenticated client.
- [Create event](https://docs.mailerpath.com/api-reference/events/create-event.md): Create a single event for the authenticated client.
- [Create events in bulk](https://docs.mailerpath.com/api-reference/events/create-events-in-bulk.md): Create multiple events for the authenticated client.
- [Get event canonical vocabulary](https://docs.mailerpath.com/api-reference/events/get-event-canonical-vocabulary.md): Returns canonical values for source, action_type, and status used in event rules.
- [List events](https://docs.mailerpath.com/api-reference/events/list-events.md): Retrieve events for the authenticated client with filters and pagination.
- [List incoming events](https://docs.mailerpath.com/api-reference/events/list-incoming-events.md): Retrieve incoming client event submissions and their processing status.
- [Get sent email detail for authenticated user](https://docs.mailerpath.com/api-reference/send/get-sent-email-detail-for-authenticated-user.md): Retrieve one sent email and its full log history for the authenticated user.
- [List sent emails for authenticated user](https://docs.mailerpath.com/api-reference/send/list-sent-emails-for-authenticated-user.md): Retrieve sent emails created by the authenticated user with optional filters and pagination.
- [Send transactional email now](https://docs.mailerpath.com/api-reference/send/send-transactional-email-now.md)
- [Create template](https://docs.mailerpath.com/api-reference/templates/create-template.md): Creates a new email template for the authenticated user.
- [Delete template](https://docs.mailerpath.com/api-reference/templates/delete-template.md): Deletes an email template for the authenticated user.
- [Get template by ID](https://docs.mailerpath.com/api-reference/templates/get-template-by-id.md): Retrieves a single email template for the authenticated user.
- [Get templates](https://docs.mailerpath.com/api-reference/templates/get-templates.md): Retrieves all email templates for the authenticated user.
- [List and filter user templates](https://docs.mailerpath.com/api-reference/templates/list-and-filter-user-templates.md): Retrieves a list of email templates for the authenticated user, with optional filtering in JSON body.
- [Render template preview](https://docs.mailerpath.com/api-reference/templates/render-template-preview.md): Renders a saved template with optional default vars, contact vars, and explicit variable overrides.
- [Update template](https://docs.mailerpath.com/api-reference/templates/update-template.md): Updates an email template for the authenticated user.
- [Cancel a queued execution](https://docs.mailerpath.com/api-reference/workflows/cancel-a-queued-execution.md): Cancel a queued execution (and its underlying queue item) by execution ID. This response acknowledges the queue operation; use GET /client/executions/{execution_id} as the source of truth for final outcome state and reason.
- [Cancel a queued workflow item](https://docs.mailerpath.com/api-reference/workflows/cancel-a-queued-workflow-item.md): Cancel a queued workflow item for the authenticated client and workflow. This response acknowledges the queue operation; use GET /client/executions/{execution_id} as the source of truth for final outcome state and reason.
- [Check whether the workflow template is ready for execution](https://docs.mailerpath.com/api-reference/workflows/check-whether-the-workflow-template-is-ready-for-execution.md): Returns whether the authenticated client's effective workflow template has a subject and at least one body. This endpoint is read-only and has no side effects.
- [Clone workflow default template for client](https://docs.mailerpath.com/api-reference/workflows/clone-workflow-default-template-for-client.md): Clones the workflow's default system template into a client-owned copy so the client can customize it. If a clone already exists it is returned as-is (idempotent). After cloning, use PATCH /workflows/{workflow_id}/customization with the returned template_id to activate the clone for this workflow.
- [Get client workflow counts by group and state](https://docs.mailerpath.com/api-reference/workflows/get-client-workflow-counts-by-group-and-state.md): Return workflow counts for the authenticated client grouped by both category and state dimensions. Each dimension shows total active workflows and client-enrolled workflows.
- [Get client workflow detail](https://docs.mailerpath.com/api-reference/workflows/get-client-workflow-detail.md): Retrieve workflow detail for the authenticated client, including send config, customization overrides, and default template preview.
- [Get client workflow execution detail](https://docs.mailerpath.com/api-reference/workflows/get-client-workflow-execution-detail.md): Retrieve a single workflow execution for the authenticated client.
- [List client workflow executions](https://docs.mailerpath.com/api-reference/workflows/list-client-workflow-executions.md): Retrieve workflow executions for the authenticated client with pagination and optional filters.
- [List client workflows](https://docs.mailerpath.com/api-reference/workflows/list-client-workflows.md): Retrieve workflows available to the authenticated client, including enrollment status, trigger tags, and template references.
- [Patch client workflow customization](https://docs.mailerpath.com/api-reference/workflows/patch-client-workflow-customization.md): Update per-client workflow overrides (template, delay, priority, send time mode/hour/minute) with validation and audit logging.
- [Retry a failed execution](https://docs.mailerpath.com/api-reference/workflows/retry-a-failed-execution.md): Retry a failed execution for the authenticated client by enqueueing a new workflow queue item. This response acknowledges queueing only; use GET /client/executions/{execution_id} as the source of truth for final outcome state and reason.
- [Run a queued execution immediately](https://docs.mailerpath.com/api-reference/workflows/run-a-queued-execution-immediately.md): Reset the scheduled time of a queued execution (and its queue item) to now. This response acknowledges the queue operation; use GET /client/executions/{execution_id} as the source of truth for final outcome state and reason.
- [Trigger a test workflow execution](https://docs.mailerpath.com/api-reference/workflows/trigger-a-test-workflow-execution.md): Enqueue a test execution for the authenticated client's workflow against a specific contact. Test executions do not count toward production metrics. Set respect_send_window=true to apply the workflow's send-time scheduling (e.g. morning slot) instead of firing immediately. This response acknowledges…
- [Compare plans](https://docs.mailerpath.com/getting-started/billing/compare-plans.md): Feature matrix across Free, Team, and Enterprise tiers for this demo help center.
- [Billing and plans](https://docs.mailerpath.com/getting-started/billing/index.md): Plans, invoices, and upgrades for your workspace.
- [Invoices and receipts](https://docs.mailerpath.com/getting-started/billing/invoices-receipts.md): Download invoices, update tax details, and reconcile charges.
- [Upgrade or downgrade your plan](https://docs.mailerpath.com/getting-started/billing/upgrade-downgrade.md): Change plans, proration, and limit changes for subscriptions.
- [Create your account](https://docs.mailerpath.com/getting-started/create-account.md): Sign up, verify your email, and choose the right organization type for your team.
- [Getting started](https://docs.mailerpath.com/getting-started/index.md): Create your account, secure access, and connect the product to the tools your team already uses.
- [Connect your CRM](https://docs.mailerpath.com/getting-started/integrations/connect-crm.md): Link Salesforce or HubSpot through partner connectors or a custom sync strategy.
- [Connect Slack](https://docs.mailerpath.com/getting-started/integrations/connect-slack.md): Install the Slack app, pick channels, and manage notifications.
- [API keys](https://docs.mailerpath.com/getting-started/integrations/developer/api-keys.md): Create, rotate, and scope API keys for server-side automation.
- [Developer integrations](https://docs.mailerpath.com/getting-started/integrations/developer/index.md): OAuth apps, webhooks, and API keys for building on the platform.
- [OAuth apps](https://docs.mailerpath.com/getting-started/integrations/developer/oauth-apps.md): Register an OAuth client, scopes, and redirect URLs for the API.
- [Webhooks](https://docs.mailerpath.com/getting-started/integrations/developer/webhooks.md): Subscribe to events, verify signatures, and retry safely.
- [Integrations overview](https://docs.mailerpath.com/getting-started/integrations/index.md): Connect Slack, CRMs, and custom tools using OAuth, webhooks, and partner connectors.
- [Custom connector template](https://docs.mailerpath.com/getting-started/integrations/partners/custom-connector-template.md): Fork the connector template to build a private integration faster.
- [HubSpot connector](https://docs.mailerpath.com/getting-started/integrations/partners/hubspot.md): Connect HubSpot CRM for deals and company records.
- [Partner connectors](https://docs.mailerpath.com/getting-started/integrations/partners/index.md): Packaged integrations for Salesforce, HubSpot, and custom connector templates.
- [Salesforce connector](https://docs.mailerpath.com/getting-started/integrations/partners/salesforce.md): Install, authenticate, and map Salesforce objects to the product.
- [Quickstart: get set up in under 15 minutes](https://docs.mailerpath.com/getting-started/quickstart.md): A fast path from signup to first project: invites, roles, and your first integration.
- [Sign-in and security basics](https://docs.mailerpath.com/getting-started/sign-in-security.md): Passwords, SSO, session length, and how we protect your workspace.
- [Workspace: teams, roles, and settings](https://docs.mailerpath.com/getting-started/workspace/index.md): Configure how people collaborate: membership, roles, and org-wide preferences.
- [Invite teammates to your workspace](https://docs.mailerpath.com/getting-started/workspace/invite-teammates.md): Send invites, assign initial roles, and manage pending invitations.
- [Organization settings](https://docs.mailerpath.com/getting-started/workspace/organization-settings.md): Name, branding touches, defaults, and workspace-level policies.
- [Roles and permissions](https://docs.mailerpath.com/getting-started/workspace/roles-permissions.md): Understand what admins, members, and custom roles can see and change.
- [Idempotency](https://docs.mailerpath.com/product/automation/advanced/idempotency.md): Use idempotency keys to make automation safe under retries.
- [Advanced patterns](https://docs.mailerpath.com/product/automation/advanced/index.md): Rate limits, idempotency, and retry policies for high-volume automation.
- [Rate limits](https://docs.mailerpath.com/product/automation/advanced/rate-limits.md): Understand automation rate limits and how to design around them.
- [Retry policies](https://docs.mailerpath.com/product/automation/advanced/retry-policies.md): Configure exponential backoff, max attempts, and dead-letter handling.
- [Automation](https://docs.mailerpath.com/product/automation/index.md): Rules, workflows, schedules, and advanced reliability patterns.
- [Rules and triggers](https://docs.mailerpath.com/product/automation/rules-triggers.md): Define when automation runs using events, filters, and guardrails.
- [Scheduled tasks](https://docs.mailerpath.com/product/automation/scheduled-tasks.md): Cron-style schedules, timezone handling, and backoff.
- [Build your first workflow](https://docs.mailerpath.com/product/automation/workflows/build-first-workflow.md): Step-by-step creation of a simple approval workflow.
- [Conditions and branches](https://docs.mailerpath.com/product/automation/workflows/conditions-branches.md): Model conditional paths and merge strategies in workflows.
- [Error handling](https://docs.mailerpath.com/product/automation/workflows/error-handling.md): Retries, compensating steps, and alerting when workflows fail.
- [Workflow builder](https://docs.mailerpath.com/product/automation/workflows/index.md): Build multi-step workflows with branches and error handling.
- [Comments and mentions](https://docs.mailerpath.com/product/editor/comments-mentions.md): Threaded comments, @mentions, and notification controls.
- [Drafts and publishing](https://docs.mailerpath.com/product/editor/drafts-publishing.md): Draft states, review cues, and what happens when you publish.
- [Editor and content](https://docs.mailerpath.com/product/editor/index.md): Drafts, publishing, comments, and version history in the editor.
- [Version history](https://docs.mailerpath.com/product/editor/version-history.md): Browse versions, compare changes, and restore content.
- [Product guides](https://docs.mailerpath.com/product/index.md): Learn the interface, projects, editor, and automation features.
- [Interface overview](https://docs.mailerpath.com/product/interface-overview.md): Sidebar, command palette, and where to find settings.
- [Keyboard shortcuts](https://docs.mailerpath.com/product/keyboard-shortcuts.md): Speed up navigation and editing with keyboard shortcuts.
- [Archive and restore projects](https://docs.mailerpath.com/product/projects/archive-restore.md): Archive completed work and restore when needed.
- [Create a project](https://docs.mailerpath.com/product/projects/create-project.md): Name, visibility, and defaults when starting a new project.
- [Projects](https://docs.mailerpath.com/product/projects/index.md): Create projects, organize work, and archive when you are done.
- [Search and navigation](https://docs.mailerpath.com/product/search-navigation.md): Find projects, pages, and automation using search.
- [Delete your account](https://docs.mailerpath.com/support/account-data/delete-account.md): Understand deletion impact and required confirmations.
- [Export your data](https://docs.mailerpath.com/support/account-data/export-data.md): Request exports, formats, and retention notes for your data.
- [Account and data](https://docs.mailerpath.com/support/account-data/index.md): Export your data and understand account deletion.
- [Contact support](https://docs.mailerpath.com/support/contact-support.md): Channels, severity levels, and what to include in a support request.
- [Support and policies](https://docs.mailerpath.com/support/index.md): Get help, check status, troubleshoot, and review legal information.
- [Legal and compliance](https://docs.mailerpath.com/support/legal/index.md): Terms, privacy, regions, and compliance topics in this demo.
- [Data processing addendum](https://docs.mailerpath.com/support/legal/privacy/dpa.md): Demo DPA overview for controllers and processors.
- [Privacy and GDPR](https://docs.mailerpath.com/support/legal/privacy/index.md): Privacy policy, DPA, and subprocessors for this demo.
- [Privacy policy](https://docs.mailerpath.com/support/legal/privacy/privacy-policy.md): Demo privacy policy for this help center.
- [Subprocessors](https://docs.mailerpath.com/support/legal/privacy/subprocessors.md): Illustrative list of subprocessors for this demo.
- [APAC](https://docs.mailerpath.com/support/legal/regions/apac.md): APAC considerations for this demo help center.
- [EU data residency](https://docs.mailerpath.com/support/legal/regions/eu-residency.md): EU data residency options in this demo help center.
- [Regional specifics](https://docs.mailerpath.com/support/legal/regions/index.md): Data residency notes for EU, US, and APAC in this demo.
- [US data residency](https://docs.mailerpath.com/support/legal/regions/us-residency.md): US data residency notes for this demo.
- [Terms of service](https://docs.mailerpath.com/support/legal/terms-of-service.md): Demo terms of service for this help center template.
- [Status and incidents](https://docs.mailerpath.com/support/status-incidents.md): Where to find live status and how incidents are communicated.
- [Troubleshooting](https://docs.mailerpath.com/support/troubleshooting/index.md): Fix common login and performance problems.
- [Login issues](https://docs.mailerpath.com/support/troubleshooting/login-issues.md): Resolve password resets, SSO failures, and session problems.
- [Performance issues](https://docs.mailerpath.com/support/troubleshooting/performance-issues.md): Diagnose slowness, large pages, and network constraints.

## OpenAPI Specs

- [openapi](https://docs.mailerpath.com/openapi.json)