# Reach Marketing & Automation Documentation

## Docs

- [Introduction](https://docs.embedreach.com/acquire/introduction.md): Reach's Acquire platform helps businesses create, manage, and optimize paid digital advertising campaigns with AI-powered tools that make advertising accessible to everyone.
- [End User Documentation](https://docs.embedreach.com/ai-voice/end-user-docs.md): Complete guide to setting up and managing your AI Voice agent
- [Introduction](https://docs.embedreach.com/ai-voice/introduction.md): Respond to incoming calls with an AI Voice agent.
- [Default Partner Resources](https://docs.embedreach.com/api-reference/endpoint/default-partner-resources-introduction.md): Convenience endpoints for default resource schemas
- [Batch Delete Customer Resources](https://docs.embedreach.com/api-reference/endpoint/delete-api-resources-customers-batch.md): Deletes multiple customer resources identified by their external IDs via the event processor for asynchronous processing.
- [Delete Customer Resource](https://docs.embedreach.com/api-reference/endpoint/delete-api-resources-customers-externalid.md): Deletes a single customer resource identified by its external ID
- [Batch Delete Location Resources](https://docs.embedreach.com/api-reference/endpoint/delete-api-resources-locations-batch.md): Deletes multiple location resources identified by their external IDs via the event processor for asynchronous processing.
- [Delete Location Resource](https://docs.embedreach.com/api-reference/endpoint/delete-api-resources-locations-externalid.md): Deletes a single location resource identified by its external ID
- [Batch Delete Resources](https://docs.embedreach.com/api-reference/endpoint/delete-api-resources-schemadefinitionnameorid-batch.md): Deletes multiple resources identified by their external IDs within a schema via the event processor for asynchronous processing. This is more efficient for large batches of data. The batch ID can be used to retrieve the status of the batch using the /api/batches/:batchId endpoint.
- [Delete Resource](https://docs.embedreach.com/api-reference/endpoint/delete-api-resources-schemadefinitionnameorid-externalid.md): Deletes a single resource identified by its schema and external ID
- [Batch Delete Transaction Resources](https://docs.embedreach.com/api-reference/endpoint/delete-api-resources-transactions-batch.md): Deletes multiple transaction resources identified by their external IDs via the event processor for asynchronous processing.
- [Delete Transaction Resource](https://docs.embedreach.com/api-reference/endpoint/delete-api-resources-transactions-externalid.md): Deletes a single transaction resource identified by its external ID
- [Delete Tenant Segment](https://docs.embedreach.com/api-reference/endpoint/delete-api-segments-id.md): Delete a tenant segment
- [Delete Tenant](https://docs.embedreach.com/api-reference/endpoint/delete-partner-tenants-id.md): Soft delete a tenant by id
- [List Tenant Automations](https://docs.embedreach.com/api-reference/endpoint/get-api-automations.md): List all tenant automations
- [Get Tenant Automation](https://docs.embedreach.com/api-reference/endpoint/get-api-automations-id.md): Get a tenant automation by id
- [Get Recipients for Tenant Automation](https://docs.embedreach.com/api-reference/endpoint/get-api-automations-id-recipients.md): Get recipients for a tenant automation by id
- [Get Statistics for Tenant Automation](https://docs.embedreach.com/api-reference/endpoint/get-api-automations-id-statistics.md): Get statistics for a tenant automation by id
- [Get Statistics for All Tenant Automations](https://docs.embedreach.com/api-reference/endpoint/get-api-automations-statistics.md): Get statistics for all tenant automations
- [List Batch Jobs](https://docs.embedreach.com/api-reference/endpoint/get-api-batches.md): Retrieves all batch jobs for a business with pagination.
- [Get Batch Status](https://docs.embedreach.com/api-reference/endpoint/get-api-batches-batchid.md): Retrieves the current status, progress, and any error details for a batch operation.
- [List Channel Accounts](https://docs.embedreach.com/api-reference/endpoint/get-api-channel-accounts.md): List all channel accounts for a business
- [List Channel Senders](https://docs.embedreach.com/api-reference/endpoint/get-api-channel-senders.md): List all channel senders for a business
- [List Communication Groups](https://docs.embedreach.com/api-reference/endpoint/get-api-communication-groups.md): List all communication groups
- [Get Link Click Statistics](https://docs.embedreach.com/api-reference/endpoint/get-api-communication-groups-automationid-link-click-stats.md): Get link click statistics for an automation
- [Get Communication Group](https://docs.embedreach.com/api-reference/endpoint/get-api-communication-groups-id.md): Get a communication group by id
- [Get Available Merge Fields](https://docs.embedreach.com/api-reference/endpoint/get-api-communication-groups-id-merge-fields.md): Get available merge fields for a communication group
- [Get Resource Counts](https://docs.embedreach.com/api-reference/endpoint/get-api-resources-counts.md): Returns the count of each resource type (schema definition) for the authenticated tenant. Useful for monitoring data syncing and comparing numbers with partner databases.
- [List Customer Resources](https://docs.embedreach.com/api-reference/endpoint/get-api-resources-customers.md): Retrieves all customer resources. Can include reference fields to resolve and filter by field values. Supports pagination using cursor and limit parameters.
- [Get Customer Resource](https://docs.embedreach.com/api-reference/endpoint/get-api-resources-customers-externalid.md): Retrieves a customer resource by its external ID. Can include reference fields to resolve and filter by field values.
- [List Location Resources](https://docs.embedreach.com/api-reference/endpoint/get-api-resources-locations.md): Retrieves all location resources. Can include reference fields to resolve and filter by field values. Supports pagination using cursor and limit parameters.
- [Get Location Resource](https://docs.embedreach.com/api-reference/endpoint/get-api-resources-locations-externalid.md): Retrieves a location resource by its external ID. Can include reference fields to resolve and filter by field values.
- [List Resources](https://docs.embedreach.com/api-reference/endpoint/get-api-resources-schemadefinitionnameorid.md): Retrieves all resources using schema name or ID. Can include reference fields to resolve and filter by field values. Supports pagination using cursor and limit parameters.
- [Get Resource](https://docs.embedreach.com/api-reference/endpoint/get-api-resources-schemadefinitionnameorid-externalid.md): Retrieves a resource by its external ID. Can include reference fields to resolve and filter by field values.
- [List Transaction Resources](https://docs.embedreach.com/api-reference/endpoint/get-api-resources-transactions.md): Retrieves all transaction resources. Can include reference fields to resolve and filter by field values. Supports pagination using cursor and limit parameters.
- [Get Transaction Resource](https://docs.embedreach.com/api-reference/endpoint/get-api-resources-transactions-externalid.md): Retrieves a transaction resource by its external ID. Can include reference fields to resolve and filter by field values.
- [List Tenant Segments](https://docs.embedreach.com/api-reference/endpoint/get-api-segments.md): List all tenant segments
- [Get Segment Conditions](https://docs.embedreach.com/api-reference/endpoint/get-api-segments-conditions.md): Get all available segment conditions
- [Get Tenant Segment](https://docs.embedreach.com/api-reference/endpoint/get-api-segments-id.md): Get a tenant segment by id
- [Get Users in Tenant Segment](https://docs.embedreach.com/api-reference/endpoint/get-api-segments-id-users.md): Get users in a tenant segment by id
- [Get Segments by User External ID](https://docs.embedreach.com/api-reference/endpoint/get-api-segments-user-externalid.md): Get all segments a user belongs to by their external ID
- [List Subscriptions](https://docs.embedreach.com/api-reference/endpoint/get-api-subscriptions.md): List all subscription information for a resource. Note: This is sorted by lastSubscriptionChangeAt in descending order
- [Get Subscription by External ID](https://docs.embedreach.com/api-reference/endpoint/get-api-subscriptions-externalid.md): Get subscription information for a specific user by their external ID
- [List Channel Integrations](https://docs.embedreach.com/api-reference/endpoint/get-partner-channel-integrations.md): List all channel integrations for a business
- [Get Resource Counts for All Tenants](https://docs.embedreach.com/api-reference/endpoint/get-partner-resources-counts.md): Returns the count of each resource type (schema definition) for all tenants of the authenticated partner. Counts are grouped by tenant external ID and schema definition. Useful for monitoring data syncing across all tenants and comparing numbers with partner databases. Supports pagination with curso…
- [List Schemas](https://docs.embedreach.com/api-reference/endpoint/get-partner-schema-definitions.md): Retrieves all active schema definitions for your system
- [Get Schema](https://docs.embedreach.com/api-reference/endpoint/get-partner-schema-definitions-schemaidorname.md): Retrieves a specific schema definition by ID or name
- [Get Partner Schema Mappings](https://docs.embedreach.com/api-reference/endpoint/get-partner-schema-mappings.md): Get partner schema mappings (Used to map important fields from partner resources to Reach Functions)
- [List Tenants](https://docs.embedreach.com/api-reference/endpoint/get-partner-tenants.md): List all tenants
- [Get Tenant](https://docs.embedreach.com/api-reference/endpoint/get-partner-tenants-id.md): Get a tenant by id or external id
- [Get Tenant Resource Statistics](https://docs.embedreach.com/api-reference/endpoint/get-partner-tenants-id-resource-stats.md): Get resource counts grouped by schema for a tenant
- [Get SMS Registration Status](https://docs.embedreach.com/api-reference/endpoint/get-partner-tenants-id-sms-registration.md): Get SMS registration application status for a tenant. Returns null if no application exists.
- [Get voice call aggregates per tenant](https://docs.embedreach.com/api-reference/endpoint/get-partner-voice-calls-aggregates.md): Returns aggregated voice call statistics grouped by tenant for the partner platform. Supports optional date range (startDate, endDate).
- [Get partner-wide voice call aggregate summary](https://docs.embedreach.com/api-reference/endpoint/get-partner-voice-calls-aggregates-summary.md): Returns platform-level rollups (active tenant count, total calls, duration, cost) for the same date filters as tenant aggregates. Separate from the paginated per-tenant aggregates endpoint.
- [Update Tenant Automation](https://docs.embedreach.com/api-reference/endpoint/patch-api-automations-id.md): Update a tenant automation
- [Update Channel Account](https://docs.embedreach.com/api-reference/endpoint/patch-api-channel-accounts-id.md): Update a channel account
- [Update Channel Sender](https://docs.embedreach.com/api-reference/endpoint/patch-api-channel-senders-id.md): Update a channel sender
- [Update Communication Group](https://docs.embedreach.com/api-reference/endpoint/patch-api-communication-groups-id.md): Update a communication group
- [Batch Patch Customer Resources](https://docs.embedreach.com/api-reference/endpoint/patch-api-resources-customers-batch.md): Patches multiple customer resources in a single batch via the event processor for asynchronous processing.
- [Patch Customer Resource](https://docs.embedreach.com/api-reference/endpoint/patch-api-resources-customers-externalid.md): Updates a customer resource by its external ID. This is an incremental update, only provided fields will be updated.
- [Batch Patch Location Resources](https://docs.embedreach.com/api-reference/endpoint/patch-api-resources-locations-batch.md): Patches multiple location resources in a single batch via the event processor for asynchronous processing.
- [Patch Location Resource](https://docs.embedreach.com/api-reference/endpoint/patch-api-resources-locations-externalid.md): Updates a location resource by its external ID. This is an incremental update, only provided fields will be updated.
- [Batch Patch Resources](https://docs.embedreach.com/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-batch.md): Patches multiple resources in a single batch via the event processor for asynchronous processing. Fields not included in the request are left unchanged. Null values will explicitly delete the field (required fields cannot be deleted and will return a validation error). The batch ID can be used to re…
- [Patch Resource](https://docs.embedreach.com/api-reference/endpoint/patch-api-resources-schemadefinitionnameorid-externalid.md): Updates a resource by its external ID. This is an incremental update, only provided fields will be updated. Fields not included in the request are left unchanged. Null values will explicitly delete the field (required fields cannot be deleted and will return a validation error).
- [Batch Patch Transaction Resources](https://docs.embedreach.com/api-reference/endpoint/patch-api-resources-transactions-batch.md): Patches multiple transaction resources in a single batch via the event processor for asynchronous processing.
- [Patch Transaction Resource](https://docs.embedreach.com/api-reference/endpoint/patch-api-resources-transactions-externalid.md): Updates a transaction resource by its external ID. This is an incremental update, only provided fields will be updated.
- [Update Tenant Segment](https://docs.embedreach.com/api-reference/endpoint/patch-api-segments-id.md): Update a tenant segment
- [Update Channel Integration](https://docs.embedreach.com/api-reference/endpoint/patch-partner-channel-integrations-id.md): Update a channel integration
- [Update Tenant](https://docs.embedreach.com/api-reference/endpoint/patch-partner-tenants-id.md): Update a tenant
- [Create or Duplicate Tenant Automation](https://docs.embedreach.com/api-reference/endpoint/post-api-automations.md): Create a new tenant automation in the draft state
- [Create Channel Account](https://docs.embedreach.com/api-reference/endpoint/post-api-channel-accounts.md): Create a new channel account
- [Create Channel Sender](https://docs.embedreach.com/api-reference/endpoint/post-api-channel-senders.md): Create a new channel sender
- [Create Communication Group](https://docs.embedreach.com/api-reference/endpoint/post-api-communication-groups.md): Create a new communication group
- [Reset Communication Group to Default Template](https://docs.embedreach.com/api-reference/endpoint/post-api-communication-groups-communicationgroupid-automationid-reset.md): Reset a communication group to the default template
- [Send Test Email/SMS](https://docs.embedreach.com/api-reference/endpoint/post-api-communication-groups-id-test.md): Send a test email/sms to the specified communication group
- [Upload SQLite database for a tenant](https://docs.embedreach.com/api-reference/endpoint/post-api-partner-db-upload.md): Upload a SQLite database file for the authenticated Tenant. Use this when each of your tenants has its own database. Send the file as multipart/form-data with the field name "file". Accepted formats: .db (raw SQLite) or .db.gz (gzip-compressed). Data is synced automatically on a schedule after uploa…
- [Create Customer Resource](https://docs.embedreach.com/api-reference/endpoint/post-api-resources-customers.md): Creates a single customer resource using the default customer schema.
- [Batch Upload Customer Resources](https://docs.embedreach.com/api-reference/endpoint/post-api-resources-customers-batch.md): Uploads multiple customer resources via the event processor for asynchronous processing. This is more efficient for large batches of data.
- [Create Location Resource](https://docs.embedreach.com/api-reference/endpoint/post-api-resources-locations.md): Creates a single location resource using the default location schema.
- [Batch Upload Location Resources](https://docs.embedreach.com/api-reference/endpoint/post-api-resources-locations-batch.md): Uploads multiple location resources via the event processor for asynchronous processing. This is more efficient for large batches of data.
- [Upload Resource](https://docs.embedreach.com/api-reference/endpoint/post-api-resources-schemadefinitionnameorid.md): Uploads data to the partner resource table after validating it against the specified schema definition. When upsert is enabled, new data is merged with existing data (preserving existing fields not included in the request). Null values will explicitly delete the field (required fields cannot be dele…
- [Batch Upload Resources](https://docs.embedreach.com/api-reference/endpoint/post-api-resources-schemadefinitionnameorid-batch.md): Uploads multiple resources via the event processor for asynchronous processing. This is more efficient for large batches of data. When upsert is enabled, new data is merged with existing data (PATCH-like behavior), preserving existing fields. Null values will explicitly delete the field (required fi…
- [Create Transaction Resource](https://docs.embedreach.com/api-reference/endpoint/post-api-resources-transactions.md): Creates a single transaction resource using the default transaction schema.
- [Batch Upload Transaction Resources](https://docs.embedreach.com/api-reference/endpoint/post-api-resources-transactions-batch.md): Uploads multiple transaction resources via the event processor for asynchronous processing. This is more efficient for large batches of data.
- [Create Tenant Segment](https://docs.embedreach.com/api-reference/endpoint/post-api-segments.md): Create a new tenant segment
- [Get Count of Users in Include and Exclude Segment](https://docs.embedreach.com/api-reference/endpoint/post-api-segments-count.md): Get count of users in an include and exclude segment
- [Text to Segment Builder](https://docs.embedreach.com/api-reference/endpoint/post-api-segments-text-to-segment.md): Text to segment builder
- [Create Channel Integration](https://docs.embedreach.com/api-reference/endpoint/post-partner-channel-integrations.md): Create a new channel integration
- [Upload SQLite database (platform-wide)](https://docs.embedreach.com/api-reference/endpoint/post-partner-partner-db-upload.md): Upload a single SQLite database file for your entire platform. Use this when you have one shared database across all tenants. Send the file as multipart/form-data with the field name "file". Accepted formats: .db (raw SQLite) or .db.gz (gzip-compressed). Data is synced automatically on a schedule af…
- [Create Schema](https://docs.embedreach.com/api-reference/endpoint/post-partner-schema-definitions.md): Creates a new schema definition
- [Update Schema](https://docs.embedreach.com/api-reference/endpoint/post-partner-schema-definitions-schemaidorname.md): Updates an existing schema definition. The update can take up to 3 mins to take effect.
- [Update Partner Schema Mappings](https://docs.embedreach.com/api-reference/endpoint/post-partner-schema-mappings.md): Update partner schema mappings (Used to map important fields from partner resources to Reach Functions)
- [Create Tenant](https://docs.embedreach.com/api-reference/endpoint/post-partner-tenants.md): Create a new tenant
- [Reactivate Tenant](https://docs.embedreach.com/api-reference/endpoint/post-partner-tenants-id-reactivate.md): Reactivate a soft-deleted tenant by id
- [Introduction](https://docs.embedreach.com/api-reference/introduction.md): Welcome to the Reach API
- [Introduction](https://docs.embedreach.com/attribution/introduction.md): Understanding how Reach attributes marketing activities to business outcomes
- [Setup](https://docs.embedreach.com/attribution/setup.md): Installing and configuring the Reach attribution tracking
- [Testing](https://docs.embedreach.com/attribution/testing.md): Verifying your attribution tracking setup is working correctly
- [Automations](https://docs.embedreach.com/automations/automations.md): Overview of Automations
- [Introduction](https://docs.embedreach.com/automations/introduction.md): Overview of Automations
- [Custom schemas](https://docs.embedreach.com/data-sharing/custom-schemas.md)
- [Introduction](https://docs.embedreach.com/data-sharing/introduction.md): Sharing customer and transaction data with Reach
- [Methods](https://docs.embedreach.com/data-sharing/methods.md): Different ways to share data with Reach
- [Requirements](https://docs.embedreach.com/data-sharing/requirements.md): Data formats and fields required for Reach integration
- [Authentication](https://docs.embedreach.com/embeddable-ui/authentication.md): Secure authentication for Reach
- [Implementing Callbacks](https://docs.embedreach.com/embeddable-ui/iframe/callbacks.md): Handle SDK events correctly
- [Customization](https://docs.embedreach.com/embeddable-ui/iframe/customization.md): Style the Reach interface to match your brand
- [Demo Mode](https://docs.embedreach.com/embeddable-ui/iframe/demo.md): Enable demo environment for testing and sales demonstrations
- [Embedding Reach](https://docs.embedreach.com/embeddable-ui/iframe/embedding.md): Add Reach to your application interface
- [Introduction](https://docs.embedreach.com/embeddable-ui/iframe/introduction.md): Embed the Reach Marketing Platform in your application as an IFrame
- [Troubleshooting](https://docs.embedreach.com/embeddable-ui/iframe/troubleshooting.md): Solutions for common SDK integration issues
- [Integration Options](https://docs.embedreach.com/embeddable-ui/integration-overview.md): Choose the right integration method for each of our core solutions based on your technical requirements and platform architecture.
- [Introduction](https://docs.embedreach.com/embeddable-ui/react/introduction.md): Embed the Reach Marketing Platform in your application as a React Component
- [How Automation Works](https://docs.embedreach.com/engage/automation-summary.md): Learn how automations work and how to create them
- [Channel Accounts](https://docs.embedreach.com/engage/channel-accounts.md): Overview of Channel Accounts
- [Channel Integrations](https://docs.embedreach.com/engage/channel-integrations.md): Overview of Channel Integrations
- [Channel Senders](https://docs.embedreach.com/engage/channel-senders.md): Overview of Channel Senders
- [Communication Groups](https://docs.embedreach.com/engage/communication-groups.md): Overview of Communication Groups
- [Email Deliverability & Domain Setup](https://docs.embedreach.com/engage/email-configuration.md): Learn what best practices are for configuring your email senders
- [End User Documentation](https://docs.embedreach.com/engage/end-user-docs.md): Complete guide from account setup to sending your first email campaign
- [Introduction](https://docs.embedreach.com/engage/introduction.md): Reach's Engage platform gives businesses a simple, but powerful tool to scale customer communications to close deals or bring customers back.
- [Glossary](https://docs.embedreach.com/home/glossary.md): Key terms and concepts used throughout our documentation.
- [Welcome to Reach](https://docs.embedreach.com/home/welcome.md): The industry-first embedded growth and retention platform for vertical software solutions
- [Introduction](https://docs.embedreach.com/measure/introduction.md): Reach's Measure platform gives businesses a consolidated view of their ad campaign performance with actionable insights to optimize their spend and improve their returns.
- [Automations Setup](https://docs.embedreach.com/onboarding/automations.md): Phase 6: Define automation templates for Engage
- [Channel Setup](https://docs.embedreach.com/onboarding/channel-setup.md): Phase 5: Configure email and SMS for Engage
- [Credentials & Setup](https://docs.embedreach.com/onboarding/credentials.md): Phase 1: Getting your Reach credentials and initial setup
- [Data Sync Setup](https://docs.embedreach.com/onboarding/data-sync-setup.md): Phase 3: Define schemas for your data structure
- [Frontend Integration](https://docs.embedreach.com/onboarding/frontend.md): Phase 2: Embed the Reach UI in your application
- [Integration Overview](https://docs.embedreach.com/onboarding/integration-overview.md): Complete step-by-step implementation process for Reach
- [Ongoing Data Sync](https://docs.embedreach.com/onboarding/ongoing-sync.md): Phase 4: Choose sync method and implement data flow
- [Welcome to Reach](https://docs.embedreach.com/onboarding/overview.md): Get started with integrating Reach into your platform
- [Reputation Setup](https://docs.embedreach.com/onboarding/reputation.md): Phase 7: Configure review requests and feedback
- [Tracking Implementation](https://docs.embedreach.com/onboarding/tracking.md): Phase 8: Implement attribution snippet for Measure/Acquire
- [Introduction](https://docs.embedreach.com/reputation/introduction.md): Automated Google review collection and optional private feedback capture.
- [Partner Configurations](https://docs.embedreach.com/reputation/partner-configurations.md): Configuration requirements and options for partners implementing the Reputation feature.
- [Embed Example](https://docs.embedreach.com/samples/embed.md): Full example of setting up the Reach SDK
- [JSON Web Token (JWT) Example](https://docs.embedreach.com/samples/jwt-tokens.md): Create a Reach compatible JWT on your backend
- [Introduction](https://docs.embedreach.com/segments/introduction.md): Overview of Segments
- [Segments](https://docs.embedreach.com/segments/segments.md): Overview of Segments

## OpenAPI Specs

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