# Omneo API

## Docs

- [Authorize a client to access the user's account](https://docs.omneo.io/api-reference/access-token/authorize-a-client-to-access-the-users-account.md)
- [Add Achievement Definition](https://docs.omneo.io/api-reference/achievement-definition/add-achievement-definition.md): A `POST` to the `/achievements/definitions` endpoint allows your application to create an Achievement Definition.
- [Browse Achievement Definitions](https://docs.omneo.io/api-reference/achievement-definition/browse-achievement-definitions.md): A `GET` to the `/achievements/definitions` endpoint allows your application to retrieve all a tenants Achievement Definitions.
- [Delete Achievement Definition](https://docs.omneo.io/api-reference/achievement-definition/delete-achievement-definition.md): A `DELETE` to the `/achievements/definitions/{definitionId}` endpoint allows your application to delete an Achievement Definition.
- [Edit Achievement Definition](https://docs.omneo.io/api-reference/achievement-definition/edit-achievement-definition.md): A `PUT` to the `/achievements/definitions/{definitionId}` endpoint allows your application edit an Achievement Definition.
- [Achievement Definitions](https://docs.omneo.io/api-reference/achievement-definition/overview.md)
- [Read Achievement Definition](https://docs.omneo.io/api-reference/achievement-definition/read-achievement-definition.md): A `GET` to the `/achievements/definitions/{definitionId}` endpoint allows your application to retrieve achievement definition.
- [Browse Action Histories](https://docs.omneo.io/api-reference/action-history/browse-action-histories.md): A `GET` to the `/action-history` endpoint allows your application to retrieve action histories.
- [Read Action History](https://docs.omneo.io/api-reference/action-history/read-action-history.md): A `GET` to the `/action-history/{action_history}` endpoint allows your application to retrieve action history.
- [Batch Allocations](https://docs.omneo.io/api-reference/allocation/batch-allocations.md): A `POST` to the `/allocations/batch.json` endpoint allows your application to process allocations in batch.
- [Browse Allocations](https://docs.omneo.io/api-reference/allocation/browse-allocations.md): A `GET` to the `/allocations` endpoint allows your application to retrieve allocations.
- [Read Allocation Count](https://docs.omneo.io/api-reference/allocation/read-allocation-count.md): A `GET` to the `/allocations/{benefitdefinition}/count` endpoint allows your application to retrieve allocation count.
- [Browse Audits](https://docs.omneo.io/api-reference/audit/browse-audits.md): A `GET` to the `/audits` endpoint allows your application to retrieve all audits.
- [Create audit](https://docs.omneo.io/api-reference/audit/create-audit.md): Create a new audit record.
- [Audits](https://docs.omneo.io/api-reference/audit/overview.md)
- [Read an Audit](https://docs.omneo.io/api-reference/audit/read-an-audit.md): A `GET` to the `/audits/{auditId}` endpoint allows your application to retrieve a specific audit record.
- [Update audit](https://docs.omneo.io/api-reference/audit/update-audit.md): Update an existing audit record.
- [Authorize a client to access the user's account](https://docs.omneo.io/api-reference/authorization/authorize-a-client-to-access-the-users-account.md)
- [Delete the given token](https://docs.omneo.io/api-reference/authorized-access-token/delete-the-given-token.md)
- [Get all of the authorized tokens for the authenticated user](https://docs.omneo.io/api-reference/authorized-access-token/get-all-of-the-authorized-tokens-for-the-authenticated-user.md)
- [Add an automation action](https://docs.omneo.io/api-reference/automation-action/add-an-automation-action.md): A `POST` to the `/automations/{automationId}/actions` endpoint allows your application to add a specific automation action
- [Delete the automation action](https://docs.omneo.io/api-reference/automation-action/delete-the-automation-action.md): A `DELETE` to the `/automations/{automationId}/actions/{actionId}` endpoint allows your application to delete an automation action.
- [Read a specific automation action](https://docs.omneo.io/api-reference/automation-action/read-a-specific-automation-action.md): A `GET` to the `/automations/{automationId}/actions/{actionId}` endpoint allows your application to retrieve a specific automation action.
- [Read automation actions](https://docs.omneo.io/api-reference/automation-action/read-automation-actions.md): A `GET` to the `/automations/{automationId}/actions` endpoint allows your application to retrieve actions for a specific automation.
- [Update an automation action](https://docs.omneo.io/api-reference/automation-action/update-an-automation-action.md): A `PUT` to the `/automations/{automationId}/actions/{actionId}` endpoint allows your application to update a specific automation action
- [Sample Automation Query Result](https://docs.omneo.io/api-reference/automation-query/sample-automation-query-result.md): A `POST` to the `/automations/queries/samples` endpoint allows your application to sample automation query result.
- [Add an automation](https://docs.omneo.io/api-reference/automation/add-an-automation.md): A `POST` to the `/automation` endpoint allows your application to create an automation.
- [Browse automations](https://docs.omneo.io/api-reference/automation/browse-automations.md): A `GET` to the `/automations` endpoint allows your application to retrieve all a tenants automations.
- [Delete the automation](https://docs.omneo.io/api-reference/automation/delete-the-automation.md): A `DELETE` to the `/automations/{automationId}` endpoint allows your application to delete an automation.
- [Edit an automation](https://docs.omneo.io/api-reference/automation/edit-an-automation.md): A `PUT` to the `/automations/{automationId}` endpoint allows your application to edit a specific automation.
- [Automations](https://docs.omneo.io/api-reference/automation/overview.md): Schedule-driven reactions that run at a configured time or interval.
- [Read an automation](https://docs.omneo.io/api-reference/automation/read-an-automation.md): A `GET` to the `/automations/{automationId}` endpoint allows your application to retrieve a specific automation.
- [Trigger Automation](https://docs.omneo.io/api-reference/automation/trigger-automation.md): A `POST` to the `/automations/{automation}/trigger` endpoint allows your application to trigger automation.
- [Add Batch](https://docs.omneo.io/api-reference/batch/add-batch.md): A `POST` to the `/batches` endpoint allows your application to create an empty batch for an import job.
- [Add Batch Items](https://docs.omneo.io/api-reference/batch/add-batch-items.md): A `POST` to the `/batches/{batch}/items` endpoint allows your application to add items to an existing batch.
- [Browse Batches](https://docs.omneo.io/api-reference/batch/browse-batches.md): A `GET` to the `/batches` endpoint allows your application to retrieve import batches with item success and failure counts.
- [Read Batch](https://docs.omneo.io/api-reference/batch/read-batch.md): A `GET` to the `/batches/{batch}` endpoint allows your application to retrieve a batch with its items.
- [Add Benefit Definition](https://docs.omneo.io/api-reference/benefit-definition/add-benefit-definition.md): A `POST` to the `/benefits/definitions` endpoint allows your application to create a Benefit Definitions.
- [Browse Benefit Definitions](https://docs.omneo.io/api-reference/benefit-definition/browse-benefit-definitions.md): A `GET` to the `/benefits/definitions` endpoint allows your application to retrieve all a tenants Benefits Definitions.
- [Browse Benefit Definitions grouped by Campaign](https://docs.omneo.io/api-reference/benefit-definition/browse-benefit-definitions-grouped-by-campaign.md): A `GET` to the `/benefits/definitions/campaigns` endpoint returns benefit definitions as a mixed paginated list. Definitions that share the same campaign are grouped into a single campaign slot. Definitions with no campaign appear as individual slots. Slots are ordered by the most recently created d…
- [Clone a Benefit Definition](https://docs.omneo.io/api-reference/benefit-definition/clone-a-benefit-definition.md): A `POST` to the `/benefits/definitions/{definitionId}/clone` endpoint allows your application to clone a specific Benefit Definition.
- [Delete Benefit Definition](https://docs.omneo.io/api-reference/benefit-definition/delete-benefit-definition.md): A `DELETE` to the `/benefits/definitions/{definitionId}` endpoint allows your application to delete a Benefit Definition.
- [Edit Benefit Definition](https://docs.omneo.io/api-reference/benefit-definition/edit-benefit-definition.md): A `PUT` to the `/benefits/definitions/{definitionId}` endpoint allows your application to edit a specific Benefit Definition.
- [Benefit Definitions](https://docs.omneo.io/api-reference/benefit-definition/overview.md)
- [Read Benefit Definition](https://docs.omneo.io/api-reference/benefit-definition/read-benefit-definition.md): A `GET` to the `/benefits/definitions/{definitionId}` endpoint allows your application to retrieve a specific Benefit Definition.
- [Read Benefit Definition by Handle](https://docs.omneo.io/api-reference/benefit-definition/read-benefit-definition-by-handle.md): A `GET` to the `/benefits/definitions/handle/{handle}` endpoint allows your application to retrieve benefit definition by handle.
- [Add Benefit Redemption](https://docs.omneo.io/api-reference/benefit-redeem/add-benefit-redemption.md): A `POST` to the `/profiles/{profileId}/benefits/{benefitId}/redeem` endpoint allows your application to create Benefit Redemption.
- [Add Benefit Return](https://docs.omneo.io/api-reference/benefit-redeem/add-benefit-return.md): A `POST` to the `/redemptions/{redemptionId}/benefit/return` endpoint allows your application to create a Benefit Return.
- [Add Benefit](https://docs.omneo.io/api-reference/benefit/add-benefit.md): A `POST` to the `/benefits` endpoint allows your application to create a Benefit record.
- [Batch Benefits](https://docs.omneo.io/api-reference/benefit/batch-benefits.md): A `POST` to the `/benefits/batch.json` endpoint allows your application to process benefits in batch.
- [Browse Benefits](https://docs.omneo.io/api-reference/benefit/browse-benefits.md): A `GET` to the `/benefits` endpoint allows your application to retrieve all a tenants Benefits records.
- [Delete Benefit](https://docs.omneo.io/api-reference/benefit/delete-benefit.md): A `DELETE` to the `/benefits/{benefitId}` endpoint allows your application to delete a specific Benefit record.
- [Edit Benefit](https://docs.omneo.io/api-reference/benefit/edit-benefit.md): A `PUT` to the `/benefits/{benefitId}` endpoint allows your application to edit benefit.
- [Extend Benefit](https://docs.omneo.io/api-reference/benefit/extend-benefit.md): A `POST` to the `/benefits/extend` endpoint allows your application to extend benefit.
- [Benefits](https://docs.omneo.io/api-reference/benefit/overview.md)
- [Read Benefit](https://docs.omneo.io/api-reference/benefit/read-benefit.md): A `GET` to the `/benefits/{benefitId}` endpoint allows your application to retrieve a specific Benefit record.
- [Read Benefit Trigger Target](https://docs.omneo.io/api-reference/benefit/read-benefit-trigger-target.md): A `GET` to the `/benefits/{benefit}/trigger-target/{type}` endpoint allows your application to retrieve benefit trigger target.
- [Read Benefits Count](https://docs.omneo.io/api-reference/benefit/read-benefits-count.md): A `GET` to the `/benefits.count` endpoint allows your application to retrieve a count of all benefit metrics
- [Add Brand](https://docs.omneo.io/api-reference/brand/add-brand.md): A `POST` to the `/brands` endpoint allows your application to create brand.
- [Browse Brands](https://docs.omneo.io/api-reference/brand/browse-brands.md): A `GET` to the `/brands` endpoint allows your application to retrieve brands.
- [Delete Brand](https://docs.omneo.io/api-reference/brand/delete-brand.md): A `DELETE` to the `/brands/{brand}` endpoint allows your application to delete brand.
- [Edit Brand](https://docs.omneo.io/api-reference/brand/edit-brand.md): A `PUT` to the `/brands/{brand}` endpoint allows your application to edit brand.
- [Read Brand](https://docs.omneo.io/api-reference/brand/read-brand.md): A `GET` to the `/brands/{brand}` endpoint allows your application to retrieve brand.
- [Delete the given client](https://docs.omneo.io/api-reference/client/delete-the-given-client.md)
- [Add Connection Definition](https://docs.omneo.io/api-reference/connection-definition/add-connection-definition.md): A `POST` to the `/connection/definitions` endpoint allows your application to create a Connection Definition.
- [Browse Connection Definitions](https://docs.omneo.io/api-reference/connection-definition/browse-connection-definitions.md): A `GET` to the `/connection/definitions` endpoint allows your application to retrieve all a tenants a Tier Definitions.
- [Delete Connection Definition](https://docs.omneo.io/api-reference/connection-definition/delete-connection-definition.md): A `DELETE` to the `/connection/definitions/{connectionDefinitionId}` endpoint allows your application to delete a Connection Definition.
- [Edit Connection Definition](https://docs.omneo.io/api-reference/connection-definition/edit-connection-definition.md): A `PUT` to the `/connection/definitions/{connectionDefinitionId}` endpoint allows your application to edit a Tier Definition.
- [Read Connection Definition](https://docs.omneo.io/api-reference/connection-definition/read-connection-definition.md): A `GET` to the `/conection/definitions/{connectionDefinitionId}` endpoint allows your application to retrieve a specific Connection Definition.
- [Add Connection](https://docs.omneo.io/api-reference/connection/add-connection.md): A `POST` to the `/connections` endpoint allows your application to create a new Connection between two profiles.
- [Browse Connections](https://docs.omneo.io/api-reference/connection/browse-connections.md): A `GET` to the `/connections` endpoint allows your application to retrieve all a tenants connections.
- [Delete Connection](https://docs.omneo.io/api-reference/connection/delete-connection.md): A `Delete` to the `/connection/{connectionId}` endpoint allows your application to create a new Connection between two profiles.
- [Edit Connection](https://docs.omneo.io/api-reference/connection/edit-connection.md): A `PUT` to the `/connections/{connectionId}` endpoint allows your application to edit connection.
- [Read A Connection](https://docs.omneo.io/api-reference/connection/read-a-connection.md): A `GET` to the `/connections/{connectionId}` endpoint allows your application to retrieve a specific connection.
- [Add Country](https://docs.omneo.io/api-reference/country/add-country.md): A `POST` to the `/countries` endpoint allows your application to create country.
- [Browse Countries](https://docs.omneo.io/api-reference/country/browse-countries.md): A `GET` to the `/countries` endpoint allows your application to retrieve countries.
- [Delete Country](https://docs.omneo.io/api-reference/country/delete-country.md): A `DELETE` to the `/countries/{country}` endpoint allows your application to delete country.
- [Edit Country](https://docs.omneo.io/api-reference/country/edit-country.md): A `PUT` to the `/countries/{country}` endpoint allows your application to edit country.
- [Read Country](https://docs.omneo.io/api-reference/country/read-country.md): A `GET` to the `/countries/{country}` endpoint allows your application to retrieve country.
- [Add Credit Definition](https://docs.omneo.io/api-reference/credit-definition/add-credit-definition.md): A `POST` to the `/credits/definitions` endpoint allows your application to create a Credit Definition.
- [Browse Credit Definitions](https://docs.omneo.io/api-reference/credit-definition/browse-credit-definitions.md): A `GET` to the `/credits/definitions` endpoint allows your application to retrieve all a tenants Credit Definitions.
- [Delete Credit Definition](https://docs.omneo.io/api-reference/credit-definition/delete-credit-definition.md): A `DELETE` to the `/credits/definitions/{definitionId}` endpoint allows your application to delete a Credit Definition.
- [Edit Credit Definition](https://docs.omneo.io/api-reference/credit-definition/edit-credit-definition.md): A `PUT` to the `/credits/definitions/{definitionId}` endpoint allows your application to edit a specific Credit Definition.
- [Read Credit Definition](https://docs.omneo.io/api-reference/credit-definition/read-credit-definition.md): A `GET` to the `/credits/definitions/{definitionId}` endpoint allows your application to retrieve a specific Credit Definition.
- [Add Credit](https://docs.omneo.io/api-reference/credit/add-credit.md): A `POST` to the `/credits` endpoint allows your application to create a Credit record.
- [Browse Credits](https://docs.omneo.io/api-reference/credit/browse-credits.md): A `GET` to the `/credits` endpoint allows your application to retrieve all a tenants Credit records.
- [Delete Credit](https://docs.omneo.io/api-reference/credit/delete-credit.md): A `DELETE` to the `/credits/{creditId}` endpoint allows your application to delete a Credit record.
- [Edit Credit](https://docs.omneo.io/api-reference/credit/edit-credit.md): A `PUT` to the `/credits/{creditId}` endpoint allows your application to edit a Credit record.
- [Extend Credit](https://docs.omneo.io/api-reference/credit/extend-credit.md): A `POST` to the `/credits/extend` endpoint allows your application to extend the expiry date of a Credit.
- [Read Credit](https://docs.omneo.io/api-reference/credit/read-credit.md): A `GET` to the `/credits/{creditId}` endpoint allows your application to retrieve a specific Credit record.
- [Add Currency](https://docs.omneo.io/api-reference/currency/add-currency.md): A `POST` to the `/currencies` endpoint allows your application to create currency.
- [Browse Currencies](https://docs.omneo.io/api-reference/currency/browse-currencies.md): A `GET` to the `/currencies` endpoint allows your application to retrieve currencies.
- [Delete Currency](https://docs.omneo.io/api-reference/currency/delete-currency.md): A `DELETE` to the `/currencies/{currency}` endpoint allows your application to delete currency.
- [Edit Currency](https://docs.omneo.io/api-reference/currency/edit-currency.md): A `PUT` to the `/currencies/{currency}` endpoint allows your application to edit currency.
- [Read Currency](https://docs.omneo.io/api-reference/currency/read-currency.md): A `GET` to the `/currencies/{currency}` endpoint allows your application to retrieve currency.
- [Add Custom Field](https://docs.omneo.io/api-reference/custom-field/add-custom-field.md): A `POST` to the `/custom-fields/{model}/{id}` endpoint allows your application to create custom field.
- [Batch Delete Custom Fields](https://docs.omneo.io/api-reference/custom-field/batch-delete-custom-fields.md): A `DELETE` to the `/custom-fields/{model}/{id}/batchJsonDelete` endpoint allows your application to delete custom fields in batch.
- [Browse Custom Fields](https://docs.omneo.io/api-reference/custom-field/browse-custom-fields.md): A `GET` to the `/custom-fields/{model}/{id}` endpoint allows your application to retrieve custom fields.
- [Delete Custom Field](https://docs.omneo.io/api-reference/custom-field/delete-custom-field.md): A `DELETE` to the `/custom-fields/{model}/{id}/{customField}` endpoint allows your application to delete custom field.
- [Search Custom Fields](https://docs.omneo.io/api-reference/custom-field/search-custom-fields.md): A `GET` to the `/custom-fields/search` endpoint allows your application to search custom fields.
- [Add Custom Product](https://docs.omneo.io/api-reference/custom-product/add-custom-product.md): A `POST` to the `/customProducts` endpoint allows your application to create custom product.
- [Browse Custom Products](https://docs.omneo.io/api-reference/custom-product/browse-custom-products.md): A `GET` to the `/customProducts` endpoint allows your application to retrieve custom products.
- [Delete Custom Product](https://docs.omneo.io/api-reference/custom-product/delete-custom-product.md): A `DELETE` to the `/customProducts/{customProduct}` endpoint allows your application to delete custom product.
- [Edit Custom Product](https://docs.omneo.io/api-reference/custom-product/edit-custom-product.md): A `PUT` to the `/customProducts/{customProduct}` endpoint allows your application to edit custom product.
- [Read Custom Product](https://docs.omneo.io/api-reference/custom-product/read-custom-product.md): A `GET` to the `/customProducts/{customProduct}` endpoint allows your application to retrieve custom product.
- [Add Department](https://docs.omneo.io/api-reference/department/add-department.md): A `POST` to the `/departments` endpoint allows your application to create department.
- [Browse Departments](https://docs.omneo.io/api-reference/department/browse-departments.md): A `GET` to the `/departments` endpoint allows your application to retrieve departments.
- [Delete Department](https://docs.omneo.io/api-reference/department/delete-department.md): A `DELETE` to the `/departments/{department}` endpoint allows your application to delete department.
- [Edit Department](https://docs.omneo.io/api-reference/department/edit-department.md): A `PUT` to the `/departments/{department}` endpoint allows your application to edit department.
- [Read Department](https://docs.omneo.io/api-reference/department/read-department.md): A `GET` to the `/departments/{department}` endpoint allows your application to retrieve department.
- [Read Health](https://docs.omneo.io/api-reference/health/read-health.md): A `GET` to the `/health` endpoint allows your application to confirm the API is responding.
- [Browse Profile Identities](https://docs.omneo.io/api-reference/identity/browse-profile-identities.md): A `GET` to the `/identities` endpoint allows your application to retrieve a list of all Profiles Identities.
- [Search Profiles by Identity](https://docs.omneo.io/api-reference/identity/search-profiles-by-identity.md): A `GET` to the `/identities/search-profile/{identifier}` endpoint allows your application to search profiles by identity.
- [Add Import Job](https://docs.omneo.io/api-reference/import-job/add-import-job.md): A `POST` to the `/imports/{importId}/jobs` endpoint allows your application to queue another job for this import.
- [Batch Import Jobs](https://docs.omneo.io/api-reference/import-job/batch-import-jobs.md): A `POST` to the `/imports/{importId}/jobs/batch.json` endpoint allows your application to queue multiple jobs for processing.
- [Browse Import Jobs](https://docs.omneo.io/api-reference/import-job/browse-import-jobs.md): A `GET` to the `/imports/{importId}/jobs` endpoint allows your application to list jobs created for an import.
- [Export Import Jobs](https://docs.omneo.io/api-reference/import-job/export-import-jobs.md): A `POST` to the `/imports/{importId}/jobs/export` endpoint allows your application to export job data as CSV.
- [Finalize Import Job](https://docs.omneo.io/api-reference/import-job/finalize-import-job.md): A `POST` to the `/imports/{importId}/jobs/{jobId}/finalize` endpoint allows your application to set the expected batch count for an import job.
- [Read Import Job](https://docs.omneo.io/api-reference/import-job/read-import-job.md): A `GET` to the `/imports/{importId}/jobs/{jobId}` endpoint allows your application to retrieve the details for an import job.
- [Browse Conditional Imports](https://docs.omneo.io/api-reference/import/browse-conditional-imports.md): A `POST` to the `/imports/condition` endpoint allows your application to retrieve imports that leverage conditions.
- [Browse Imports](https://docs.omneo.io/api-reference/import/browse-imports.md): A `GET` to the `/imports` endpoint allows your application to retrieve recent import runs.
- [Create Manual Import](https://docs.omneo.io/api-reference/import/create-manual-import.md): A `POST` to the `/imports/manual` endpoint allows your application to create an import record without uploading a file.
- [Delete Import](https://docs.omneo.io/api-reference/import/delete-import.md): A `DELETE` to the `/imports/{importId}` endpoint allows your application to remove an import record and any pending jobs.
- [Read Import](https://docs.omneo.io/api-reference/import/read-import.md): A `GET` to the `/imports/{importId}` endpoint allows your application to retrieve a specific import run.
- [Upload Import](https://docs.omneo.io/api-reference/import/upload-import.md): A `POST` to the `/imports` endpoint allows your application to upload a file and dispatch a handler managed import.
- [Upload Import Mapping File](https://docs.omneo.io/api-reference/import/upload-import-mapping-file.md): A `POST` to the `/imports/file` endpoint allows your application to upload a CSV and mapping configuration for entity specific imports.
- [Add Interaction](https://docs.omneo.io/api-reference/interaction/add-interaction.md): A `POST` to the `/interactions` endpoint allows your application to create interaction.
- [Browse Interactions](https://docs.omneo.io/api-reference/interaction/browse-interactions.md): A `GET` to the `/interactions` endpoint allows your application to retrieve interactions.
- [Delete Interaction](https://docs.omneo.io/api-reference/interaction/delete-interaction.md): A `DELETE` to the `/interactions/{interaction}` endpoint allows your application to delete interaction.
- [Edit Interaction](https://docs.omneo.io/api-reference/interaction/edit-interaction.md): A `PUT` to the `/interactions/{interaction}` endpoint allows your application to edit interaction.
- [Interactions](https://docs.omneo.io/api-reference/interaction/overview.md): Records of customer touchpoints and engagement events across channels.
- [Read Interaction](https://docs.omneo.io/api-reference/interaction/read-interaction.md): A `GET` to the `/interactions/{interaction}` endpoint allows your application to retrieve interaction.
- [Omneo API Reference](https://docs.omneo.io/api-reference/introduction.md): REST API for the Omneo loyalty and CX platform
- [Browse Ledgers](https://docs.omneo.io/api-reference/ledger/browse-ledgers.md): A `GET` to the `/profiles/{profile}/ledgers` endpoint allows your application to retrieve ledgers.
- [Read Ledger](https://docs.omneo.io/api-reference/ledger/read-ledger.md): A `GET` to the `/profiles/{profile}/ledgers/{ledger}` endpoint allows your application to retrieve ledger.
- [Add List Custom Field](https://docs.omneo.io/api-reference/list-custom-field/add-list-custom-field.md): A `POST` to the `/profiles/{profile}/lists/{list}/custom-fields` endpoint allows your application to create list custom field.
- [Browse List Custom Fields](https://docs.omneo.io/api-reference/list-custom-field/browse-list-custom-fields.md): A `GET` to the `/profiles/{profile}/lists/{list}/custom-fields` endpoint allows your application to retrieve list custom fields.
- [Delete List Custom Field](https://docs.omneo.io/api-reference/list-custom-field/delete-list-custom-field.md): A `DELETE` to the `/profiles/{profile}/lists/{list}/custom-fields/{custom_field}` endpoint allows your application to delete list custom field.
- [Edit List Custom Field](https://docs.omneo.io/api-reference/list-custom-field/edit-list-custom-field.md): A `PUT` to the `/profiles/{profile}/lists/{list}/custom-fields/{custom_field}` endpoint allows your application to edit list custom field.
- [Read List Custom Field](https://docs.omneo.io/api-reference/list-custom-field/read-list-custom-field.md): A `GET` to the `/profiles/{profile}/lists/{list}/custom-fields/{custom_field}` endpoint allows your application to retrieve list custom field.
- [Add List Definition](https://docs.omneo.io/api-reference/list-definition/add-list-definition.md): A `POST` to the `/lists/definitions` endpoint allows your application to create a List Definition.
- [Browse List Definitions](https://docs.omneo.io/api-reference/list-definition/browse-list-definitions.md): A `GET` to the `/lists/definitions` endpoint allows your application to retrieve all a tenants List Definitions.
- [Delete List Definition](https://docs.omneo.io/api-reference/list-definition/delete-list-definition.md): A `DELETE` to the `/lists/definitions/{definitionId}` endpoint allows your application to delete a List Definition.
- [Edit List Definition](https://docs.omneo.io/api-reference/list-definition/edit-list-definition.md): A `PUT` to the `/lists/definitions/{definitionId}` endpoint allows your application to edit a List Definition.
- [Read List Definition](https://docs.omneo.io/api-reference/list-definition/read-list-definition.md): A `GET` to the `/lists/definitions/{definitionId}` endpoint allows your application to retrieve a specific List Definition.
- [Add Location Custom Field](https://docs.omneo.io/api-reference/location-custom-field/add-location-custom-field.md): A `POST` to the `/locations/{location}/custom-fields` endpoint allows your application to create location custom field.
- [Browse Location Custom Fields](https://docs.omneo.io/api-reference/location-custom-field/browse-location-custom-fields.md): A `GET` to the `/locations/{location}/custom-fields` endpoint allows your application to retrieve location custom fields.
- [Delete Location Custom Field](https://docs.omneo.io/api-reference/location-custom-field/delete-location-custom-field.md): A `DELETE` to the `/locations/{location}/custom-fields/{custom_field}` endpoint allows your application to delete location custom field.
- [Edit Location Custom Field](https://docs.omneo.io/api-reference/location-custom-field/edit-location-custom-field.md): A `PUT` to the `/locations/{location}/custom-fields/{custom_field}` endpoint allows your application to edit location custom field.
- [Read Location Custom Field](https://docs.omneo.io/api-reference/location-custom-field/read-location-custom-field.md): A `GET` to the `/locations/{location}/custom-fields/{custom_field}` endpoint allows your application to retrieve location custom field.
- [Add Location](https://docs.omneo.io/api-reference/location/add-location.md): A `POST` to the `/locations` endpoint allows your application to add a Location.
- [Batch Locations](https://docs.omneo.io/api-reference/location/batch-locations.md): A `POST` to the `/locations/batch.json` endpoint allows your application to process locations in batch.
- [Browse Locations](https://docs.omneo.io/api-reference/location/browse-locations.md): A `GET` to the `/locations` endpoint allows your application to retrieve all an tenants Location records.
- [Delete Location](https://docs.omneo.io/api-reference/location/delete-location.md): A `DELETE` to the `/locations/{locationId}` endpoint allows your application to delete a Location record.
- [Edit Location](https://docs.omneo.io/api-reference/location/edit-location.md): A `PUT` to the `/locations/{locationId}` endpoint allows your application to edit a Location record.
- [Locations](https://docs.omneo.io/api-reference/location/overview.md)
- [Read Location](https://docs.omneo.io/api-reference/location/read-location.md): A `GET` to the `/locations/{locationId}` endpoint allows your application to retrieve a specific Location record.
- [Read Location By External](https://docs.omneo.io/api-reference/location/read-location-by-external.md): A `GET` to the `/locations/{type}/{id}` endpoint allows your application to retrieve a specific Location record by an external_id or external_code.
- [Add Order Item](https://docs.omneo.io/api-reference/order-item/add-order-item.md): A `POST` to the `/orders/{orderId}/items` endpoint allows your application to add an Item (Products) to an Order record.
- [Browse Order Items](https://docs.omneo.io/api-reference/order-item/browse-order-items.md): A `GET` to the `/orders/{orderId}/items` endpoint allows your application to retrieve all Items (Products) associated with an Order.
- [Delete an order item](https://docs.omneo.io/api-reference/order-item/delete-an-order-item.md): A `DELETE` to the `/orders/{orderId}/items/{itemId}` endpoint allows your application to delete an Order Item.
- [Edit Order Item](https://docs.omneo.io/api-reference/order-item/edit-order-item.md): A `PUT` to the `/orders/{orderId}/items/{itemId}` endpoint allows your application to edit an Order Item.
- [Read Order Item](https://docs.omneo.io/api-reference/order-item/read-order-item.md): A `GET` to the `/orders/{orderId}/items/{itemId}` endpoint allows your application to a specific Order Item associated with an Order record.
- [Add Order](https://docs.omneo.io/api-reference/order/add-order.md): A `POST` to the `/orders` endpoint allows your application to create order.
- [Batch Orders](https://docs.omneo.io/api-reference/order/batch-orders.md): A `POST` to the `/orders/batch.json` endpoint allows your application to process orders in batch.
- [Browse Orders](https://docs.omneo.io/api-reference/order/browse-orders.md): A `GET` to the `/orders` endpoint allows your application to retrieve orders.
- [Delete Order](https://docs.omneo.io/api-reference/order/delete-order.md): A `DELETE` to the `/orders/{order}` endpoint allows your application to delete order.
- [Edit Order](https://docs.omneo.io/api-reference/order/edit-order.md): A `PUT` to the `/orders/{order}` endpoint allows your application to edit order.
- [Queue Order Create Request](https://docs.omneo.io/api-reference/order/queue-order-create-request.md): A `POST` to the `/orders/queue` endpoint allows your application to queue order create request.
- [Queue Order Create Request](https://docs.omneo.io/api-reference/order/queue-order-create-request-1.md): A `POST` to the `/orders/queue/create` endpoint allows your application to queue order create request.
- [Read Order](https://docs.omneo.io/api-reference/order/read-order.md): A `GET` to the `/orders/{order}` endpoint allows your application to retrieve order.
- [Resend Order Payload](https://docs.omneo.io/api-reference/order/resend-order-payload.md): A `POST` to the `/orders/{id}/resend` endpoint allows your application to resend order payload.
- [Add Organisation Profile](https://docs.omneo.io/api-reference/organisation-profile/add-organisation-profile.md): A `POST` to the `/organisations/{organisationId}/profiles` endpoint allows your application to create organisation profile.
- [Browse Organisation Profiles](https://docs.omneo.io/api-reference/organisation-profile/browse-organisation-profiles.md): A `GET` to the `/organisations/{organisationId}/profiles` endpoint allows your application to retrieve organisation profiles.
- [Delete Organisation Profile](https://docs.omneo.io/api-reference/organisation-profile/delete-organisation-profile.md): A `DELETE` to the `/organisations/{organisationId}/profiles/{profileId}` endpoint allows your application to delete organisation profile.
- [Add Organisation](https://docs.omneo.io/api-reference/organisation/add-organisation.md): A `POST` to the `/organisations` endpoint allows your application to create organisation.
- [Edit Organisation](https://docs.omneo.io/api-reference/organisation/edit-organisation.md): A `PUT` to the `/organisations/{id}` endpoint allows your application to edit organisation.
- [List all organisations](https://docs.omneo.io/api-reference/organisation/list-all-organisations.md): Retrieve organisations list.
- [Read Organisation](https://docs.omneo.io/api-reference/organisation/read-organisation.md): A `GET` to the `/organisations/{id}` endpoint allows your application to retrieve organisation.
- [Create a new personal access token for the user](https://docs.omneo.io/api-reference/personal-access-token/create-a-new-personal-access-token-for-the-user.md)
- [Create a new personal access token for the user](https://docs.omneo.io/api-reference/personal-access-token/create-a-new-personal-access-token-for-the-user-1.md)
- [Delete the given token](https://docs.omneo.io/api-reference/personal-access-token/delete-the-given-token.md)
- [Delete the given token](https://docs.omneo.io/api-reference/personal-access-token/delete-the-given-token-1.md)
- [Get all of the personal access tokens for the authenticated user](https://docs.omneo.io/api-reference/personal-access-token/get-all-of-the-personal-access-tokens-for-the-authenticated-user.md)
- [Add Point Definition](https://docs.omneo.io/api-reference/point-definition/add-point-definition.md): A `POST` to the `/points/definitions` endpoint allows your application to create a Points Definition.
- [Browse Point Definitions](https://docs.omneo.io/api-reference/point-definition/browse-point-definitions.md): A `GET` to the `/points/definitions` endpoint allows your application to retrieve all a tenants Points Definitions.
- [Delete Point Definition](https://docs.omneo.io/api-reference/point-definition/delete-point-definition.md): A `DELETE` to the `/points/definitions/{definitionId}` endpoint allows your application to delete a Points Definition.
- [Edit Point Definition](https://docs.omneo.io/api-reference/point-definition/edit-point-definition.md): A `PUT` to the `/points/definitions/{definitionId}` endpoint allows your application to edit a specific Points Definition record.
- [Point Definitions](https://docs.omneo.io/api-reference/point-definition/overview.md)
- [Read Point Definition](https://docs.omneo.io/api-reference/point-definition/read-point-definition.md): A `GET` to the `/points/definitions/{definitionId}` endpoint allows your application to retrieve a specific Points Definition record.
- [Add Point](https://docs.omneo.io/api-reference/point/add-point.md): A `POST` to the `/points` endpoint allows your application to create point.
- [Browse Points](https://docs.omneo.io/api-reference/point/browse-points.md): A `GET` to the `/points` endpoint allows your application to retrieve points.
- [Points](https://docs.omneo.io/api-reference/point/overview.md)
- [Read Point](https://docs.omneo.io/api-reference/point/read-point.md): A `GET` to the `/points/{point}` endpoint allows your application to retrieve point.
- [Add Custom Product to Profile List](https://docs.omneo.io/api-reference/product-list-item/add-custom-product-to-profile-list.md): A `POST` to the `/profiles/{profile}/lists/{handle}/custom` endpoint allows your application to create custom product to profile list.
- [Add Profile List Item](https://docs.omneo.io/api-reference/product-list-item/add-profile-list-item.md): A `POST` to the `/profiles/{profileId}/lists/{listHandle}/items` endpoint allows your application to add a Item to a Profile List.
- [Delete Profile List Item](https://docs.omneo.io/api-reference/product-list-item/delete-profile-list-item.md): A `DELETE` to the `/profiles/{profileId}/lists/{listHandle}/items/{itemId}` endpoint allows your application to delete an Item from a Profile List.
- [Edit Profile List Item](https://docs.omneo.io/api-reference/product-list-item/edit-profile-list-item.md): A `PUT` to the `/profiles/{profileId}/lists/{listHandle}/items/{itemId}` endpoint allows your application to edit an Item from a Profile List.
- [Read Profile List Item](https://docs.omneo.io/api-reference/product-list-item/read-profile-list-item.md): A `GET` to the `/profiles/{profileId}/lists/{listHandle}/items/{itemId}` endpoint allows your application to retrieve an Item from a Profile List.
- [Read Profile List Items](https://docs.omneo.io/api-reference/product-list-item/read-profile-list-items.md): A `GET` to the `/profiles/{profileId}/lists/{listHandle}/items` endpoint allows your application to retrieve a listing of all Items of a Profile List.
- [Add List Reservation](https://docs.omneo.io/api-reference/product-list-reservations/add-list-reservation.md): A `POST` to the `/list/items/{itemId}/reservations` endpoint allows your application to create a reservation for a list item.
- [Browse Profile Reservations](https://docs.omneo.io/api-reference/product-list-reservations/browse-profile-reservations.md): A `GET` to the `/profiles/{profileId}/reservations` endpoint allows your application to retrieve a listing of reservations for a Profile.
- [Delete List Reservation](https://docs.omneo.io/api-reference/product-list-reservations/delete-list-reservation.md): A `DELETE` to the `/list/items/{itemId}/reservations/{reservationId}` endpoint allows your application to delete a list reservation.
- [Edit List Reservation](https://docs.omneo.io/api-reference/product-list-reservations/edit-list-reservation.md): A `PUT` to the `/list/items/{itemId}/reservations/{reservationId}` endpoint allows your application to edit a list reservation.
- [Read Product List](https://docs.omneo.io/api-reference/product-list-reservations/read-product-list.md): A `GET` to the `/lists/{list}` endpoint allows your application to retrieve product list.
- [Add Product List Share](https://docs.omneo.io/api-reference/product-list-share/add-product-list-share.md): A `POST` to the `/profiles/{profile}/lists/{list}/shares` endpoint allows your application to create product list share.
- [Delete Product List Share](https://docs.omneo.io/api-reference/product-list-share/delete-product-list-share.md): A `DELETE` to the `/profiles/{profile}/lists/{list}/shares/{share}` endpoint allows your application to delete product list share.
- [Read Shared Product List](https://docs.omneo.io/api-reference/product-list-share/read-shared-product-list.md): A `GET` to the `/lists/shares/{handle}` endpoint allows your application to retrieve shared product list.
- [Read Shared Product List Without Profile](https://docs.omneo.io/api-reference/product-list-share/read-shared-product-list-without-profile.md): A `GET` to the `/lists/shares/{handle}/no_profile` endpoint allows your application to retrieve shared product list without profile.
- [Add Profile List](https://docs.omneo.io/api-reference/product-list/add-profile-list.md): A `POST` to the `profiles/{profileId}/lists` endpoint allows your application to create a Profile List.
- [Browse Profile Lists](https://docs.omneo.io/api-reference/product-list/browse-profile-lists.md): A `GET` to the `profiles/{profileId}/lists` endpoint allows your application to retrieve all Lists associated with a Profile.
- [Delete Profile List](https://docs.omneo.io/api-reference/product-list/delete-profile-list.md): A `DELETE` to the `/profiles/{profileId}/lists/{listHandle}` endpoint allows your application to delete a specific Profile List.
- [Edit Profile List](https://docs.omneo.io/api-reference/product-list/edit-profile-list.md): A `PUT` to the `/profiles/{profileId}/lists/{listHandle}` endpoint allows your application to edit a specific Profile List.
- [Profile Lists](https://docs.omneo.io/api-reference/product-list/overview.md)
- [Read Profile List](https://docs.omneo.io/api-reference/product-list/read-profile-list.md): A `GET` to the `/profiles/{profileId}/lists/{listHandle}` endpoint allows your application to retrieve a specific Profile List.
- [Search Product Lists](https://docs.omneo.io/api-reference/product-list/search-product-lists.md): A `GET` to the `/product-lists/search` endpoint allows your application to search product lists.
- [Add Product Variant](https://docs.omneo.io/api-reference/product-variant/add-product-variant.md): A `POST` to the `/products/{productId}/variants` endpoint allows your application to create a Product Variant.
- [Browse Product Variants](https://docs.omneo.io/api-reference/product-variant/browse-product-variants.md): A `GET` to the `/products/variants` endpoint allows your application to retrieve product variants.
- [Browse Product Variants](https://docs.omneo.io/api-reference/product-variant/browse-product-variants-1.md): A `GET` to the `/products/{productId}/variants` endpoint allows your application to retrieve all Variants of a Product record.
- [Delete Product Variant](https://docs.omneo.io/api-reference/product-variant/delete-product-variant.md): A `DELETE` to the `/products/{productId}/variants/{variantId}` endpoint allows your application to delete a Product Variant.
- [Edit Product Variant](https://docs.omneo.io/api-reference/product-variant/edit-product-variant.md): A `PUT` to the `/products/{productId}/variants/{variantId}` endpoint allows your application to edit product variant.
- [Product Variants](https://docs.omneo.io/api-reference/product-variant/overview.md)
- [Read Product Variant](https://docs.omneo.io/api-reference/product-variant/read-product-variant.md): A `GET` to the `/products/{productId}/variants/{variantId}` endpoint allows your application to retrieve a specific Product Variant.
- [Add Product](https://docs.omneo.io/api-reference/product/add-product.md): A `POST` to the `/products` endpoint allows your application to create a Product.
- [Batch Products](https://docs.omneo.io/api-reference/product/batch-products.md): A `POST` to the `/products/batch.json` endpoint allows your application to process products in batch.
- [Browse Products](https://docs.omneo.io/api-reference/product/browse-products.md): A `GET` to the `/products` endpoint allows your application to retrieve all a tenants Product records.
- [Delete Product](https://docs.omneo.io/api-reference/product/delete-product.md): A `DELETE` to the `/products/{productId}` endpoint allows your application to delete a Product record.
- [Edit Product](https://docs.omneo.io/api-reference/product/edit-product.md): A `PUT` to the `/products/{productId}` endpoint allows your application to edit a Product record.
- [Products](https://docs.omneo.io/api-reference/product/overview.md)
- [Queue Product](https://docs.omneo.io/api-reference/product/queue-product.md): A `POST` to the `/products/queue` endpoint allows your application to create a Product by adding to the process queue.
- [Read Product](https://docs.omneo.io/api-reference/product/read-product.md): A `GET` to the `/products/{productId}` endpoint allows your application to retrieve a specific Product record.
- [Update or Create Product](https://docs.omneo.io/api-reference/product/update-or-create-product.md): A `POST` to the `/products/create-update` endpoint allows your application to update or create product.
- [Update or Create Product](https://docs.omneo.io/api-reference/product/update-or-create-product-1.md): A `POST` to the `/products/create-update` endpoint allows your application to update or create product.
- [Browse Profile Achievement Points](https://docs.omneo.io/api-reference/profile-achievement-point/browse-profile-achievement-points.md): A `GET` to the `/profiles/{profile}/achievements/{definition}/achievement-points` endpoint allows your application to retrieve profile achievement points.
- [Add Profile Achievement](https://docs.omneo.io/api-reference/profile-achievement/add-profile-achievement.md): A `POST` to the `/profiles/{profileId}/achievements` endpoint allows your application create a Profile Achievement, incrementing or decrementing the Achivements count.
- [Browse Profile Achievements](https://docs.omneo.io/api-reference/profile-achievement/browse-profile-achievements.md): A `GET` to the `/profiles/{profileId}/achievement` endpoint allows your application to retrieve all a Profiles Achievements.
- [Achievements](https://docs.omneo.io/api-reference/profile-achievement/overview.md)
- [Add or Update Profile Address](https://docs.omneo.io/api-reference/profile-address/add-or-update-profile-address.md): A `POST` to the `/profiles/{profile}/addresses/upsert` endpoint allows your application to create or update profile address.
- [Add Profile Address](https://docs.omneo.io/api-reference/profile-address/add-profile-address.md): A `POST` to the `/profiles/{profileId}/addresses` endpoint allows your application to create a Profiles Address.
- [Browse Profile Addresses](https://docs.omneo.io/api-reference/profile-address/browse-profile-addresses.md): A `GET` to the `/profiles/{profileId}/addresses` endpoint allows your application to get a list of a Profiles Addresses.
- [Delete Profile Address](https://docs.omneo.io/api-reference/profile-address/delete-profile-address.md): A `DELETE` to the `/profiles/{profileId}/addresses/{addressId}` endpoint allows your application to delete a specific Profiles Address.
- [Edit Profile Address](https://docs.omneo.io/api-reference/profile-address/edit-profile-address.md): A `PUT` to the `/profiles/{profileId}/addresses/{addressId}` endpoint allows your application to edit a specific Profile Address record.
- [Profile Addresses](https://docs.omneo.io/api-reference/profile-address/overview.md)
- [Read Profile Address](https://docs.omneo.io/api-reference/profile-address/read-profile-address.md): A `GET` to the `/profiles/{profileId}/addresses/{addressId}` endpoint allows your application to get a specific Profile Address record.
- [Batch Profile Aggregations](https://docs.omneo.io/api-reference/profile-aggregation/batch-profile-aggregations.md): A `POST` to the `/profile/aggregations/batch.json` endpoint allows your application to process profile aggregations in batch.
- [Calculate Profile Aggregations](https://docs.omneo.io/api-reference/profile-aggregation/calculate-profile-aggregations.md): A `GET` to the `/profiles/{profile}/aggregations/calculate` endpoint allows your application to calculate profile aggregations.
- [Edit Profile Aggregation](https://docs.omneo.io/api-reference/profile-aggregation/edit-profile-aggregation.md): A `PUT` to the `/profiles/{profileId}/aggregations` endpoint allows your application to edit profile aggregation.
- [Aggregations](https://docs.omneo.io/api-reference/profile-aggregation/overview.md)
- [Read Aggregations](https://docs.omneo.io/api-reference/profile-aggregation/read-aggregations.md): A `GET` to the `/profiles/{profileId}/aggregations` endpoint allows your application to retrieve a Profiles Aggregations.
- [Edit Profile Attributes (Appearance)](https://docs.omneo.io/api-reference/profile-appearance-attribute/edit-profile-attributes-appearance.md): A `PUT` to the `/profiles/{profileId}/attributes/appearance` endpoint allows your application to edit the Attributes relating to the Profiles physical Appearance.
- [Profile Attributes (Appearance)](https://docs.omneo.io/api-reference/profile-appearance-attribute/overview.md)
- [Read Profile Attributes (Appearance)](https://docs.omneo.io/api-reference/profile-appearance-attribute/read-profile-attributes-appearance.md): A `GET` to the `/profiles/{profileId}/attributes/appearance` endpoint allows your application to get the Attributes relating to the Profiles physical Appearance.
- [Balances](https://docs.omneo.io/api-reference/profile-balance/overview.md)
- [Read Profile Balances](https://docs.omneo.io/api-reference/profile-balance/read-profile-balances.md): A `GET` to the `/profiles/{profileId}/balances` endpoint allows your application to retrieve a Profiles Balances.
- [Add and Redeem Benefit Claim](https://docs.omneo.io/api-reference/profile-benefit/add-and-redeem-benefit-claim.md): A `POST` to the `/profiles/{profileId}/benefits/claim-redeem` endpoint allows your application to create and immediatly claim a Benefit Redemption.
- [Browse Profile Benefits](https://docs.omneo.io/api-reference/profile-benefit/browse-profile-benefits.md): A `GET` to the `/profiles/{profileId}/benefits` endpoint allows your application to retrieve all Benefits records associated with a Profile.
- [Browse Profile Claimable Benefits](https://docs.omneo.io/api-reference/profile-benefit/browse-profile-claimable-benefits.md): A `GET` to the `/profiles/{profileId}/benefits/claimable` endpoint allows your application to retrieve all Benefits records associated with a Profile.
- [Browse Profile Redeemable Benefits](https://docs.omneo.io/api-reference/profile-benefit/browse-profile-redeemable-benefits.md): A `GET` to the `/profiles/{profileId}/redeemable_benefits` endpoint allows your application to retrieve all redeemable Benefits records associated with a Profile.
- [Browse Viewable Profile Benefits](https://docs.omneo.io/api-reference/profile-benefit/browse-viewable-profile-benefits.md): A `GET` to the `/profiles/{profile}/benefits/viewable` endpoint allows your application to retrieve viewable profile benefits.
- [Claim Benefit](https://docs.omneo.io/api-reference/profile-benefit/claim-benefit.md): A `POST` to the `/profiles/{profile}/benefits/claim` endpoint allows your application to claim benefit.
- [Delete Benefit](https://docs.omneo.io/api-reference/profile-benefit/delete-benefit.md): A `DELETE` to the `/profiles/{profileId}/benefits/{benefitId}` endpoint allows your application to delete a specific Benefit record.
- [Read Profile Benefit](https://docs.omneo.io/api-reference/profile-benefit/read-profile-benefit.md): A `GET` to the `/profiles/{profileId}/benefits/{benefitId}` endpoint allows your application to retrieve a specific Benefit record associated with a Profile.
- [Retrieve benefit definitions matching the profile's visibility condition](https://docs.omneo.io/api-reference/profile-benefit/retrieve-benefit-definitions-matching-the-profiles-visibility-condition.md): Returns benefit definitions where the visibility_condition evaluates to true for the given profile.
- [Update a profile Benefit](https://docs.omneo.io/api-reference/profile-benefit/update-a-profile-benefit.md): A `PUT` to the `/profiles/{profileId}/benefits/{benefitId}` endpoint allows your application to update a specific Benefit record.
- [Edit Profile Attributes (Comms)](https://docs.omneo.io/api-reference/profile-comms-attribute/edit-profile-attributes-comms.md): A `PUT` to the `/profiles/{profileId}/attributes/comms` endpoint allows your application to get the Profiles Attributes relating to the Profiles Communications preferences.
- [Profile Attributes (Comms)](https://docs.omneo.io/api-reference/profile-comms-attribute/overview.md)
- [Read Profile Attributes (Comms)](https://docs.omneo.io/api-reference/profile-comms-attribute/read-profile-attributes-comms.md): A `GET` to the `/profiles/{profileId}/attributes/comms` endpoint allows your application to get the Attributes relating to a Profiles Communications preferences.
- [Edit Profile Connection](https://docs.omneo.io/api-reference/profile-connection/edit-profile-connection.md): A `PUT` to the `/profiles/{profileId}/connections/{connectionId}` endpoint allows your application to edit profile connection.
- [Read Connected Profile Data](https://docs.omneo.io/api-reference/profile-connection/read-connected-profile-data.md): A `GET` to the `/profiles/{profileId}/connections/{connectionId}/profileInfo` endpoint allows your application to retrieve the values matching the shareable_attributes on the connected profile.
- [Read Profile Connections](https://docs.omneo.io/api-reference/profile-connection/read-profile-connections.md): A `GET` to the `/profiles/{profileId}/connections` endpoint allows your application to retrieve a Profiles Connections data.
- [Browse Profile Credits](https://docs.omneo.io/api-reference/profile-credit/browse-profile-credits.md): A `GET` to the `/profiles/{profile}/credits` endpoint allows your application to retrieve profile credits.
- [Redeem Profile Credit](https://docs.omneo.io/api-reference/profile-credit/redeem-profile-credit.md): A `POST` to the `/profiles/{profileId}/credits/{creditId}/redeem` endpoint allows your application to redeem value from a Credit owned by the Profile.
- [Batch Profile Custom Attributes](https://docs.omneo.io/api-reference/profile-custom-attribute/batch-profile-custom-attributes.md): A `POST` to the `/profile/custom-attributes/batch.json` endpoint allows your application to queue profile custom attribute updates from a JSON payload.
- [Delete Profile Custom Attribute](https://docs.omneo.io/api-reference/profile-custom-attribute/delete-profile-custom-attribute.md): A `DELETE` to the `/profiles/{profile}/attributes/custom/{custom}` endpoint allows your application to delete profile custom attribute.
- [Edit Profile Custom Attribute](https://docs.omneo.io/api-reference/profile-custom-attribute/edit-profile-custom-attribute.md): A `PUT` to the `/profiles/{profile}/attributes/custom/{custom}` endpoint allows your application to edit profile custom attribute.
- [Read Profile Attributes (Custom)](https://docs.omneo.io/api-reference/profile-custom-attribute/read-profile-attributes-custom.md): A `GET` to the `/profiles/{profileId}/attributes/custom` endpoint allows your application to get the Attributes relating to a Profiles Custom preferences.
- [Read Profile Custom Attribute](https://docs.omneo.io/api-reference/profile-custom-attribute/read-profile-custom-attribute.md): A `GET` to the `/profiles/{profile}/attributes/custom/{custom}` endpoint allows your application to retrieve profile custom attribute.
- [Search Profiles by Custom Attributes](https://docs.omneo.io/api-reference/profile-custom-attribute/search-profiles-by-custom-attributes.md): A `GET` to the `/profiles/attributes/custom` endpoint allows your application to search profiles by custom attributes.
- [Delete Profile Date Attribute](https://docs.omneo.io/api-reference/profile-dates-attribute/delete-profile-date-attribute.md): A `DELETE` to the `/profiles/{profileId}/dates/attributes/{dateId}` endpoint allows your application to delete a Profile Date Attribute.
- [Edit Profile Attributes (Dates)](https://docs.omneo.io/api-reference/profile-dates-attribute/edit-profile-attributes-dates.md): A `PUT` to the `/profiles/{profileId}/attributes/dates` endpoint allows your application to get the Profiles Attributes relating to the Profiles Dates preferences.
- [Read Profile Attributes (Dates)](https://docs.omneo.io/api-reference/profile-dates-attribute/read-profile-attributes-dates.md): A `GET` to the `/profiles/{profileId}/attributes/dates` endpoint allows your application to get the Attributes relating to the Profiles Dates.
- [Add Profile Identity](https://docs.omneo.io/api-reference/profile-identity/add-profile-identity.md): A `POST` to the `/profiles/{profileId}/identities` endpoint allows your application to create a Profile Identity.
- [Delete Profile Identity](https://docs.omneo.io/api-reference/profile-identity/delete-profile-identity.md): A `DELETE` to the `/profiles/{profileId}/identities/{identityHandle}` endpoint allows your application to delete a Profile Identity.
- [Delete Profile Identity by ID](https://docs.omneo.io/api-reference/profile-identity/delete-profile-identity-by-id.md): A `DELETE` to the `/profiles/{profile}/identities/id/{identity}` endpoint allows your application to delete profile identity by id.
- [Edit Profile Identity](https://docs.omneo.io/api-reference/profile-identity/edit-profile-identity.md): A `PUT` to the `/profiles/{profileId}/identities/{identityHandle}` endpoint allows your application to edit a Profile Identity.
- [Edit Profile Identity by ID](https://docs.omneo.io/api-reference/profile-identity/edit-profile-identity-by-id.md): A `PUT` to the `/profiles/{profile}/identities/id/{identity}` endpoint allows your application to edit profile identity by id.
- [Profile Identities](https://docs.omneo.io/api-reference/profile-identity/overview.md)
- [Read Profile Identity](https://docs.omneo.io/api-reference/profile-identity/read-profile-identity.md): A `GET` to the `/profiles/{profileId}/identities/{identityHandle}` endpoint allows your application to get a specfic namespaced Profile Identity associated with that Profile.
- [Read Profile Identity by ID](https://docs.omneo.io/api-reference/profile-identity/read-profile-identity-by-id.md): A `GET` to the `/profiles/{profile}/identities/id/{identity}` endpoint allows your application to retrieve profile identity by id.
- [Read Profile's Identities](https://docs.omneo.io/api-reference/profile-identity/read-profiles-identities.md): A `GET` to the `/profiles/{profileId}/identities` endpoint allows your application to get all Profile Identities associated with that Profile.
- [Browse Profile Interactions](https://docs.omneo.io/api-reference/profile-interaction/browse-profile-interactions.md): A `GET` to the `/profiles/{profile}/interactions` endpoint allows your application to retrieve profile interactions.
- [Delete Profile Interaction](https://docs.omneo.io/api-reference/profile-interaction/delete-profile-interaction.md): A `DELETE` to the `/profiles/{profile}/interactions/{interaction}` endpoint allows your application to delete profile interaction.
- [Read Profile Interaction](https://docs.omneo.io/api-reference/profile-interaction/read-profile-interaction.md): A `GET` to the `/profiles/{profile}/interactions/{interaction}` endpoint allows your application to retrieve profile interaction.
- [Browse Grouped Profile Orders](https://docs.omneo.io/api-reference/profile-order/browse-grouped-profile-orders.md): A `GET` to the `/profiles/{profile}/group_orders` endpoint allows your application to retrieve grouped profile orders.
- [Browse Profile Orders](https://docs.omneo.io/api-reference/profile-order/browse-profile-orders.md): A `GET` to the `/profiles/{profile}/orders` endpoint allows your application to retrieve profile orders.
- [Read Profile Order](https://docs.omneo.io/api-reference/profile-order/read-profile-order.md): A `GET` to the `/profiles/{profile}/orders/{order}` endpoint allows your application to retrieve profile order.
- [Browse Linked Profile Points](https://docs.omneo.io/api-reference/profile-point/browse-linked-profile-points.md): A `GET` to the `/profiles/{profile}/linked_points` endpoint allows your application to retrieve linked profile points.
- [Browse Profile Points](https://docs.omneo.io/api-reference/profile-point/browse-profile-points.md): A `GET` to the `/profiles/{profileId}/points` endpoint allows your application to retrieve all Points records associated with a Profile.
- [Read Profile Point](https://docs.omneo.io/api-reference/profile-point/read-profile-point.md): A `GET` to the `/profiles/{profileId}/points/{pointId}` endpoint allows your application to retrieve a specific Point record associated with a Profile.
- [Browse Linked Profile Redemptions](https://docs.omneo.io/api-reference/profile-redemption/browse-linked-profile-redemptions.md): A `GET` to the `/profiles/{profile}/linked_redemptions` endpoint allows your application to retrieve linked profile redemptions.
- [Browse Linked Profile Redemptions](https://docs.omneo.io/api-reference/profile-redemption/browse-linked-profile-redemptions-1.md): A `GET` to the `/profiles/{profile}/linked/redemptions` endpoint allows your application to retrieve linked profile redemptions.
- [Browse Profile Redemptions](https://docs.omneo.io/api-reference/profile-redemption/browse-profile-redemptions.md): A `GET` to the `/profiles/{profileId}/redemptions` endpoint allows your application to retrieve all Redemption records associated with a Profile.
- [Read Profile Redemption](https://docs.omneo.io/api-reference/profile-redemption/read-profile-redemption.md): A `GET` to the `/profiles/{profileId}/redemptions/{redemptionId}` endpoint allows your application to retrieve a specific Redemption record associated with a Profile.
- [Read Redemption Count](https://docs.omneo.io/api-reference/profile-redemption/read-redemption-count.md): A `GET` to the `/profiles/{profile}/redemptions/{type}/{id}/count` endpoint allows your application to retrieve redemption count.
- [Add Profile Region](https://docs.omneo.io/api-reference/profile-region/add-profile-region.md): A `POST` to the `/profiles/{profile}/regions` endpoint allows your application to create profile region.
- [Batch Profile Regions](https://docs.omneo.io/api-reference/profile-region/batch-profile-regions.md): A `POST` to the `/profile/regions/batch.json` endpoint allows your application to queue profile region updates from a JSON payload.
- [Browse Profile Regions](https://docs.omneo.io/api-reference/profile-region/browse-profile-regions.md): A `GET` to the `/profiles/{profile}/regions` endpoint allows your application to retrieve profile regions.
- [Delete Profile Region](https://docs.omneo.io/api-reference/profile-region/delete-profile-region.md): A `DELETE` to the `/profiles/{profile}/regions/{region}` endpoint allows your application to delete profile region.
- [Edit Profile Region](https://docs.omneo.io/api-reference/profile-region/edit-profile-region.md): A `PUT` to the `/profiles/{profile}/regions/{region}` endpoint allows your application to edit profile region.
- [Browse Profile Rewards](https://docs.omneo.io/api-reference/profile-reward/browse-profile-rewards.md): A `GET` to the `/profiles/{profileId}/rewards` endpoint allows your application to retrieve all Reward records associated with a Profile.
- [Read Profile Reward](https://docs.omneo.io/api-reference/profile-reward/read-profile-reward.md): A `GET` to the `/profiles/{profileId}/rewards/{rewardId}` endpoint allows your application to retrieve a specific Reward records associated with a Profile.
- [Batch Delete Profile Statuses](https://docs.omneo.io/api-reference/profile-status/batch-delete-profile-statuses.md): A `DELETE` to the `/profile/status/batch.json` endpoint allows your application to delete profile statuses in batch.
- [Batch Update Profile Statuses](https://docs.omneo.io/api-reference/profile-status/batch-update-profile-statuses.md): A `POST` to the `/profile/status/batch.json` endpoint allows your application to update profile statuses in batch.
- [Batch Delete Profile Tags](https://docs.omneo.io/api-reference/profile-tag/batch-delete-profile-tags.md): A `DELETE` to the `/profile/tags/batch.json` endpoint allows your application to delete profile tags in batch.
- [Batch Update Profile Tags](https://docs.omneo.io/api-reference/profile-tag/batch-update-profile-tags.md): A `POST` to the `/profile/tags/batch.json` endpoint allows your application to update profile tags in batch.
- [Browse Profile Tier Points](https://docs.omneo.io/api-reference/profile-tier-point/browse-profile-tier-points.md): A `GET` to the `/profiles/{profile}/tiers/points` endpoint allows your application to retrieve profile tier points.
- [Assign Profile Tier](https://docs.omneo.io/api-reference/profile-tier/assign-profile-tier.md): A `POST` to the `/profiles/{profile}/tiers/assign` endpoint allows your application to assign profile tier.
- [Calculate Profile Tier](https://docs.omneo.io/api-reference/profile-tier/calculate-profile-tier.md): A `GET` to the `/profiles/{profile}/tiers/calculate` endpoint allows your application to calculate profile tier.
- [Tier](https://docs.omneo.io/api-reference/profile-tier/overview.md)
- [Read Profile Tier](https://docs.omneo.io/api-reference/profile-tier/read-profile-tier.md): A `GET` to the `/profiles/{profileId}/tiers` endpoint allows your application to retrieve a Profiles Tier data.
- [Add Profile Transaction Claim](https://docs.omneo.io/api-reference/profile-transaction-claim/add-profile-transaction-claim.md): A `POST` to the `/profiles/{profile}/transactions/claims` endpoint allows your application to create profile transaction claim.
- [Browse Profile Transaction Claims](https://docs.omneo.io/api-reference/profile-transaction-claim/browse-profile-transaction-claims.md): A `GET` to the `/profiles/{profile}/transactions/claims` endpoint allows your application to retrieve profile transaction claims.
- [Delete Profile Transaction Claim](https://docs.omneo.io/api-reference/profile-transaction-claim/delete-profile-transaction-claim.md): A `DELETE` to the `/profiles/{profile}/transactions/claims/{transactionClaim}` endpoint allows your application to delete profile transaction claim.
- [Read Profile Transaction Claim](https://docs.omneo.io/api-reference/profile-transaction-claim/read-profile-transaction-claim.md): A `GET` to the `/profiles/{profile}/transactions/claims/{transactionClaim}` endpoint allows your application to retrieve profile transaction claim.
- [Browse Profile Transaction Items](https://docs.omneo.io/api-reference/profile-transaction-item/browse-profile-transaction-items.md): A `GET` to the `/profiles/{profile}/transactionitems/list/{type}` endpoint allows your application to retrieve profile transaction items.
- [Browse Grouped Profile Transactions](https://docs.omneo.io/api-reference/profile-transaction/browse-grouped-profile-transactions.md): A `GET` to the `/profiles/{profile}/group_transactions` endpoint allows your application to retrieve grouped profile transactions.
- [Browse Profile Transaction Products](https://docs.omneo.io/api-reference/profile-transaction/browse-profile-transaction-products.md): A `GET` to the `/profiles/{profile}/transaction-products` endpoint allows your application to retrieve profile transaction products.
- [Browse Profile Transactions](https://docs.omneo.io/api-reference/profile-transaction/browse-profile-transactions.md): A `GET` to the `/profiles/{profileId}/transactions` endpoint allows your application to retrieve all Transactions associated with a Profile.
- [Detach Profile from Transaction](https://docs.omneo.io/api-reference/profile-transaction/detach-profile-from-transaction.md): A `GET` to the `/profiles/{profile}/transactions/{transaction}/unattach` endpoint allows your application to detach profile from transaction.
- [Read Profile Transaction](https://docs.omneo.io/api-reference/profile-transaction/read-profile-transaction.md): A `GET` to the `/profiles/{profileId}/transactions/{transactionId}` endpoint allows your application to retrieve a specific Transaction associated with a Profile.
- [Search Profile Transactions](https://docs.omneo.io/api-reference/profile-transaction/search-profile-transactions.md): A `GET` to the `/profiles/{profile}/find-transactions` endpoint allows your application to search profile transactions.
- [Browse Profile Validation Rule Values](https://docs.omneo.io/api-reference/profile-validation-rule-value/browse-profile-validation-rule-values.md): A `GET` to the `/profiles/validation-rules/{ruleId}/values` endpoint allows your application to retrieve all values for a specific Profile Validation Rule.
- [Create Profile Validation Rule Value](https://docs.omneo.io/api-reference/profile-validation-rule-value/create-profile-validation-rule-value.md): A `POST` to the `/profiles/validation-rules/{ruleId}/values` endpoint allows your application to add a new value to a Profile Validation Rule.
- [Delete Profile Validation Rule Value](https://docs.omneo.io/api-reference/profile-validation-rule-value/delete-profile-validation-rule-value.md): A `DELETE` to the `/profiles/validation-rules/{ruleId}/values/{valueId}` endpoint allows your application to delete a specific Profile Validation Rule Value.
- [Read Profile Validation Rule Value](https://docs.omneo.io/api-reference/profile-validation-rule-value/read-profile-validation-rule-value.md): A `GET` to the `/profiles/validation-rules/{ruleId}/values/{valueId}` endpoint allows your application to retrieve a specific Profile Validation Rule Value.
- [Update Profile Validation Rule Value](https://docs.omneo.io/api-reference/profile-validation-rule-value/update-profile-validation-rule-value.md): A `PATCH` to the `/profiles/validation-rules/{ruleId}/values/{valueId}` endpoint allows your application to update a specific Profile Validation Rule Value.
- [Browse Profile Validation Rules](https://docs.omneo.io/api-reference/profile-validation-rule/browse-profile-validation-rules.md): A `GET` to the `/profiles/validation-rules` endpoint allows your application to retrieve all Profile Validation Rules.
- [Create Profile Validation Rule](https://docs.omneo.io/api-reference/profile-validation-rule/create-profile-validation-rule.md): A `POST` to the `/profiles/validation-rules` endpoint allows your application to create a new Profile Validation Rule.
- [Delete Profile Validation Rule](https://docs.omneo.io/api-reference/profile-validation-rule/delete-profile-validation-rule.md): A `DELETE` to the `/profiles/validation-rules/{ruleId}` endpoint allows your application to delete a specific Profile Validation Rule and all its associated values.
- [Read Profile Validation Rule](https://docs.omneo.io/api-reference/profile-validation-rule/read-profile-validation-rule.md): A `GET` to the `/profiles/validation-rules/{ruleId}` endpoint allows your application to retrieve a specific Profile Validation Rule including its values.
- [Update Profile Validation Rule](https://docs.omneo.io/api-reference/profile-validation-rule/update-profile-validation-rule.md): A `PATCH` to the `/profiles/validation-rules/{ruleId}` endpoint allows your application to update a specific Profile Validation Rule.
- [Add Profile](https://docs.omneo.io/api-reference/profile/add-profile.md): A `POST` to the `/profiles` endpoint allows your application to create a new Profile record.
- [Batch Profiles](https://docs.omneo.io/api-reference/profile/batch-profiles.md): A `POST` to the `/profiles/batch.json` endpoint allows your application to process profiles in batch.
- [Batch Profiles](https://docs.omneo.io/api-reference/profile/batch-profiles-1.md): A `POST` to the `/profiles/batch.json` endpoint allows your application to process profiles in batch.
- [Browse Profiles](https://docs.omneo.io/api-reference/profile/browse-profiles.md): A `GET` to the `/profiles` endpoint allows your application to retrieve a listing of all the tenants Profile records.
- [Check Availability](https://docs.omneo.io/api-reference/profile/check-availability.md): A `POST` to the `/profiles/availability` endpoint allows your application get the availability of an email or mobile
- [Check Profile Existence](https://docs.omneo.io/api-reference/profile/check-profile-existence.md): A `POST` to the `/profiles/exists` endpoint allows your application to check profile existence.
- [Delete Profile](https://docs.omneo.io/api-reference/profile/delete-profile.md): A `DELETE` to the `/profiles/{profileId}` endpoint allows your application to delete a Profile record.
- [Edit Profile](https://docs.omneo.io/api-reference/profile/edit-profile.md): A `PUT` to the `/profiles/{profileId}` endpoint allows your application to edit the Profile record.
- [Edit Profile Public Status](https://docs.omneo.io/api-reference/profile/edit-profile-public-status.md): A `PUT` to the `/profiles/{profileId}/public` endpoint allows your application to update whether a profile is public.
- [Get Profile By Id or Identity](https://docs.omneo.io/api-reference/profile/get-profile-by-id-or-identity.md): A `POST` to the `/profiles/search-id` allows your application to search for a profile by identity handle/identifier, or simply by profile_id
- [Merge Profiles](https://docs.omneo.io/api-reference/profile/merge-profiles.md): A `POST` to the `/profiles/merge` merges the source profile into the destination profile
- [Profiles](https://docs.omneo.io/api-reference/profile/overview.md): The central customer record in Omneo — everything links to a profile.
- [Purge Profile](https://docs.omneo.io/api-reference/profile/purge-profile.md): A `DELETE` to the `/profiles/{profileId}/purge` endpoint allows your application to hard delete a Profile record.
- [Read Profile](https://docs.omneo.io/api-reference/profile/read-profile.md): A `GET` to the `/profiles/{profileId}` endpoint allows your application to retrieve the full Profile record.
- [Resync Profile](https://docs.omneo.io/api-reference/profile/resync-profile.md): A `GET` to the `/profiles/{profile}/resync` endpoint allows your application to resync profile.
- [Sync Profiles](https://docs.omneo.io/api-reference/profile/sync-profiles.md): A `POST` to the `/profiles/sync` triggers a sync for all profiles where the `updated_at` is greater than the sync date.
- [Trigger Profile Custom Event](https://docs.omneo.io/api-reference/profile/trigger-profile-custom-event.md): A `POST` to the `/profiles/{profile}/custom-event` endpoint allows your application to trigger profile custom event.
- [Update Profile Type](https://docs.omneo.io/api-reference/profile/update-profile-type.md): A `PUT` to the `/profiles/{profileId}/update-type` endpoint allows your application to update a profiles type
- [Add Rate](https://docs.omneo.io/api-reference/rate/add-rate.md): A `POST` to the `/rates` endpoint allows your application to create rate.
- [Browse Rates](https://docs.omneo.io/api-reference/rate/browse-rates.md): A `GET` to the `/rates` endpoint allows your application to retrieve rates.
- [Calculate Rate](https://docs.omneo.io/api-reference/rate/calculate-rate.md): A `POST` to the `/rates/calculate` endpoint allows your application to calculate a discount for a given product.
- [Delete Rate](https://docs.omneo.io/api-reference/rate/delete-rate.md): A `DELETE` to the `/rates/{rate}` endpoint allows your application to delete rate.
- [Edit Rate](https://docs.omneo.io/api-reference/rate/edit-rate.md): A `PUT` to the `/rates/{rate}` endpoint allows your application to edit rate.
- [Estimate Rate For Product](https://docs.omneo.io/api-reference/rate/estimate-rate-for-product.md): A `POST` to the `/rates/product-estimate` endpoint returns the estimated rate for a product without persisting any data.
- [Estimate Rate For Product Variant](https://docs.omneo.io/api-reference/rate/estimate-rate-for-product-variant.md): A `POST` to the `/rates/product-variant-estimate` endpoint returns the estimated rate for a product variant without persisting any data. Identify the variant by providing one of `sku`, `external_id`, or `barcode`.
- [Read Rate](https://docs.omneo.io/api-reference/rate/read-rate.md): A `GET` to the `/rates/{rate}` endpoint allows your application to retrieve rate.
- [Search Rates by Attribute](https://docs.omneo.io/api-reference/rate/search-rates-by-attribute.md): A `GET` to the `/rates/searchAttributes/{attribute}` endpoint allows your application to search rates by attribute.
- [Add Rating](https://docs.omneo.io/api-reference/rating/add-rating.md): A `POST` to the `/ratings` endpoint allows your application to create a Rating.
- [Browse Ratings](https://docs.omneo.io/api-reference/rating/browse-ratings.md): A `GET` to the `/ratings` endpoint allows your application to retrieve all a tenants ratings.
- [Delete Rating](https://docs.omneo.io/api-reference/rating/delete-rating.md): A `DELETE` to the `/ratings/{ratingId}` endpoint allows your application to delete a Rating.
- [Edit Rating](https://docs.omneo.io/api-reference/rating/edit-rating.md): A `PUT` to the `/ratings/{ratingId}` endpoint allows your application to edit a Rating record.
- [Read Rating](https://docs.omneo.io/api-reference/rating/read-rating.md): A `GET` to the `/ratings/{ratingId}` endpoint allows your application to retrieve a specific Rating.
- [Add Reward, Point, or Credit Redemption](https://docs.omneo.io/api-reference/redeem-strategy/add-reward-point-or-credit-redemption.md): A `POST` to the `/profiles/{profileId}/redeem` endpoint allows your application to create Reward, Points, or Credits Redemption.
- [Browse Redemption Items](https://docs.omneo.io/api-reference/redemption-item/browse-redemption-items.md): A `GET` to the `/redemptions/items` endpoint allows your application to retrieve all Redemption Item records.
- [Read Redemption Item](https://docs.omneo.io/api-reference/redemption-item/read-redemption-item.md): A `GET` to the `/redemptions/items/{redemptionItemId}` endpoint allows your application to retrieve a specific Redemption Item record.
- [Browse Redemptions](https://docs.omneo.io/api-reference/redemption/browse-redemptions.md): A `GET` to the `/redemptions` endpoint allows your application to retrieve all Redemption records.
- [Group Redemptions](https://docs.omneo.io/api-reference/redemption/group-redemptions.md): A `GET` to the `/redemptions/group/{attribute}` endpoint allows your application to group redemptions.
- [Redemptions](https://docs.omneo.io/api-reference/redemption/overview.md)
- [Read Redemption](https://docs.omneo.io/api-reference/redemption/read-redemption.md): A `GET` to the `/redemptions/{redemptionId}` endpoint allows your application to retrieve a specific Redemption record.
- [Invoke the controller method](https://docs.omneo.io/api-reference/redirect/invoke-the-controller-method.md)
- [Invoke the controller method](https://docs.omneo.io/api-reference/redirect/invoke-the-controller-method-1.md)
- [Add Region](https://docs.omneo.io/api-reference/region/add-region.md): A `POST` to the `/regions` endpoint allows your application to create region.
- [Browse Regions](https://docs.omneo.io/api-reference/region/browse-regions.md): A `GET` to the `/regions` endpoint allows your application to retrieve regions.
- [Delete Region](https://docs.omneo.io/api-reference/region/delete-region.md): A `DELETE` to the `/regions/{region}` endpoint allows your application to delete region.
- [Edit Region](https://docs.omneo.io/api-reference/region/edit-region.md): A `PUT` to the `/regions/{region}` endpoint allows your application to edit region.
- [Read Region](https://docs.omneo.io/api-reference/region/read-region.md): A `GET` to the `/regions/{region}` endpoint allows your application to retrieve region.
- [Add Reminder](https://docs.omneo.io/api-reference/reminder/add-reminder.md): A `POST` to the `/reminders` endpoint allows your application to create reminder.
- [Browse Reminders](https://docs.omneo.io/api-reference/reminder/browse-reminders.md): A `GET` to the `/reminders` endpoint allows your application to retrieve reminders.
- [Delete Reminder](https://docs.omneo.io/api-reference/reminder/delete-reminder.md): A `DELETE` to the `/reminders/{reminder}` endpoint allows your application to delete reminder.
- [Edit Reminder](https://docs.omneo.io/api-reference/reminder/edit-reminder.md): A `PUT` to the `/reminders/{reminder}` endpoint allows your application to edit reminder.
- [Read Reminder](https://docs.omneo.io/api-reference/reminder/read-reminder.md): A `GET` to the `/reminders/{reminder}` endpoint allows your application to retrieve reminder.
- [Add Redemption Reversal](https://docs.omneo.io/api-reference/return-strategy/add-redemption-reversal.md): A `POST` to the `/redemptions/{redemptionId}/reversal` endpoint allows your application Reverse any Redemption created within the last 10 minutes.
- [Add Reward or Point Return](https://docs.omneo.io/api-reference/return-strategy/add-reward-or-point-return.md): A `POST` to the `/redemptions/{redemptionId}/return` endpoint allows your application to create a Reward or Point Return.
- [Add Reward Definition](https://docs.omneo.io/api-reference/reward-definition/add-reward-definition.md): A `POST` to the `/rewards/definitions` endpoint allows your application to create a Reward Definition.
- [Browse Reward Definitions](https://docs.omneo.io/api-reference/reward-definition/browse-reward-definitions.md): A `GET` to the `/rewards/definitions` endpoint allows your application to retrieve all a tenants Rewards Definitions.
- [Delete Reward Definition](https://docs.omneo.io/api-reference/reward-definition/delete-reward-definition.md): A `DELETE` to the `/rewards/definitions/{definitionId}` endpoint allows your application to delete a Reward Definition.
- [Reward Definitions](https://docs.omneo.io/api-reference/reward-definition/overview.md)
- [Read Reward Definition](https://docs.omneo.io/api-reference/reward-definition/read-reward-definition.md): A `GET` to the `/rewards/definitions/{definitionId}` endpoint allows your application to retrieve a specific Reward Definition.
- [Update a reward definition](https://docs.omneo.io/api-reference/reward-definition/update-a-reward-definition.md): A `PUT` to the `/rewards/definitions/{definitionId}` endpoint allows your application to update a Reward Definition.
- [Add Reward](https://docs.omneo.io/api-reference/reward/add-reward.md): A `POST` to the `/rewards` endpoint allows your application to create a Reward record.
- [Batch Rewards](https://docs.omneo.io/api-reference/reward/batch-rewards.md): A `POST` to the `/rewards/batch.json` endpoint allows your application to process rewards in batch.
- [Browse Rewards](https://docs.omneo.io/api-reference/reward/browse-rewards.md): A `GET` to the `/rewards` endpoint allows your application to retrieve all a tenants Reward records.
- [Delete Reward](https://docs.omneo.io/api-reference/reward/delete-reward.md): A `DELETE` to the `/rewards/{rewardId}` endpoint allows your application to delete a Reward record.
- [Edit Reward](https://docs.omneo.io/api-reference/reward/edit-reward.md): A `PUT` to the `/rewards/{rewardId}` endpoint allows your application to edit a Reward record.
- [Extend Reward](https://docs.omneo.io/api-reference/reward/extend-reward.md): A `POST` to the `/rewards/extend` endpoint allows your application to extend the expiry date of a Reward.
- [Rewards](https://docs.omneo.io/api-reference/reward/overview.md)
- [Read Reward](https://docs.omneo.io/api-reference/reward/read-reward.md): A `GET` to the `/rewards/{rewardId}` endpoint allows your application to retrieve a specific Reward record.
- [Read Reward Trigger Target](https://docs.omneo.io/api-reference/reward/read-reward-trigger-target.md): A `GET` to the `/rewards/{reward}/trigger-target/{type}` endpoint allows your application to retrieve reward trigger target.
- [Add Role Definition](https://docs.omneo.io/api-reference/role-definition/add-role-definition.md): A `POST` to the `/roles/definitions` endpoint allows your application to create role definition.
- [Delete Role Definition](https://docs.omneo.io/api-reference/role-definition/delete-role-definition.md): A `DELETE` to the `/roles/definitions/{id}` endpoint allows your application to delete role definition.
- [Edit Role Definition](https://docs.omneo.io/api-reference/role-definition/edit-role-definition.md): A `PUT` to the `/roles/definitions/{id}` endpoint allows your application to edit role definition.
- [List all role definitions](https://docs.omneo.io/api-reference/role-definition/list-all-role-definitions.md): Retrieve definitions list.
- [Read Role Definition](https://docs.omneo.io/api-reference/role-definition/read-role-definition.md): A `GET` to the `/roles/definitions/{id}` endpoint allows your application to retrieve role definition.
- [Browse Roles](https://docs.omneo.io/api-reference/role/browse-roles.md): A `GET` to the `/roles` endpoint allows your application to retrieve roles.
- [Roles](https://docs.omneo.io/api-reference/role/overview.md)
- [Read Role](https://docs.omneo.io/api-reference/role/read-role.md): A `GET` to the `/roles/{role}` endpoint allows your application to retrieve role.
- [Add Saved Filter](https://docs.omneo.io/api-reference/saved-filter/add-saved-filter.md): A `POST` to the `/{modelType}/savedfilter` endpoint creates or updates a saved filter for the provided model type.
- [Browse Saved Filters](https://docs.omneo.io/api-reference/saved-filter/browse-saved-filters.md): A `GET` to the `/{modelType}/savedfilter` endpoint retrieves saved filters for the provided model type.
- [Delete Saved Filter](https://docs.omneo.io/api-reference/saved-filter/delete-saved-filter.md): A `DELETE` to the `/{modelType}/savedfilter/{savedFilterId}` endpoint removes an existing saved filter.
- [Edit Saved Filter](https://docs.omneo.io/api-reference/saved-filter/edit-saved-filter.md): A `PUT` to the `/{modelType}/savedfilter/{savedFilterId}` endpoint updates an existing saved filter.
- [Get all of the available scopes for the application](https://docs.omneo.io/api-reference/scope/get-all-of-the-available-scopes-for-the-application.md)
- [Add Setting](https://docs.omneo.io/api-reference/setting/add-setting.md): A `POST` to the `/settings` endpoint allows your application to create setting.
- [Browse settings](https://docs.omneo.io/api-reference/setting/browse-settings.md): A `GET` to the `/settings` endpoint allows your application to retrieve all a tenants setting.
- [Delete the setting](https://docs.omneo.io/api-reference/setting/delete-the-setting.md): A `DELETE` to the `/settings/{settingHandle}` endpoint allows your application to delete a setting.
- [Edit a setting](https://docs.omneo.io/api-reference/setting/edit-a-setting.md): A `PUT` to the `/settings/{settingHandle}` endpoint allows your application to edit a specific setting.
- [Read a Setting](https://docs.omneo.io/api-reference/setting/read-a-setting.md): A `GET` to the `/settings/{settingHandle}` endpoint allows your application to retrieve a specific settings.
- [Read Environment Settings](https://docs.omneo.io/api-reference/setting/read-environment-settings.md): A `GET` to the `/settings/environment` endpoint allows your application to retrieve environment settings.
- [Add Share](https://docs.omneo.io/api-reference/share/add-share.md): A `POST` to the `/shares` endpoint allows your application to create a share.
- [Browse Shares](https://docs.omneo.io/api-reference/share/browse-shares.md): A `GET` to the `/shares` endpoint allows your application to retrieve all shares.
- [Claim Share](https://docs.omneo.io/api-reference/share/claim-share.md): A `POST` to the `/shares/{handle}/claim` endpoint allows your application to claim a share.
- [Delete Share](https://docs.omneo.io/api-reference/share/delete-share.md): A `DELETE` to the `/shares/{shareId}` endpoint allows your application to delete a Share.
- [Edit Share](https://docs.omneo.io/api-reference/share/edit-share.md): A `PUT` to the `/shares/{shareId}` endpoint allows your application to update a share.
- [Read Share](https://docs.omneo.io/api-reference/share/read-share.md): A `GET` to the `/shares/{shareId}` endpoint allows your application to retrieve a specific share by id or handle.
- [Add Staff Profile](https://docs.omneo.io/api-reference/staff/add-staff-profile.md): A `POST` to the `/staff` endpoint allows your application to create a Staff Profile [Identity + Profile].
- [Delete Staff Profile](https://docs.omneo.io/api-reference/staff/delete-staff-profile.md): A `DELETE` to the `/staff/{staffIdentifier}` endpoint allows your application to delete a Staff Profile.
- [Edit Staff Profile](https://docs.omneo.io/api-reference/staff/edit-staff-profile.md): A `PUT` to the `/staff/{staffIdentifier}` endpoint allows your application to edit a Staff Profile.
- [Read Staff](https://docs.omneo.io/api-reference/staff/read-staff.md): A `GET` to the `/staff/{staffIdentifier}` endpoint allows your application to retrieve staff.
- [Add Status](https://docs.omneo.io/api-reference/status/add-status.md): A `POST` to the `/statuses` endpoint allows your application to create a Status record.
- [Browse Statuses](https://docs.omneo.io/api-reference/status/browse-statuses.md): A `GET` to the `/statuses` endpoint allows your application to retrieve all a tenants Status records.
- [Delete Status](https://docs.omneo.io/api-reference/status/delete-status.md): A `DELETE` to the `/statuses/{statusId}` endpoint allows your application to delete a Status.
- [Edit Status](https://docs.omneo.io/api-reference/status/edit-status.md): A `PUT` to the `/statuses/{statusId}` endpoint allows your application to edit a Status.
- [Statuses](https://docs.omneo.io/api-reference/status/overview.md)
- [Read Status](https://docs.omneo.io/api-reference/status/read-status.md): A `GET` to the `/statuses/{statusId}` endpoint allows your application to retrieve all a specific Status record.
- [Add System](https://docs.omneo.io/api-reference/system/add-system.md): A `POST` to the `/systems` endpoint allows your application to create system.
- [Browse Systems](https://docs.omneo.io/api-reference/system/browse-systems.md): A `GET` to the `/systems` endpoint allows your application to retrieve systems.
- [Delete System](https://docs.omneo.io/api-reference/system/delete-system.md): A `DELETE` to the `/systems/{system}` endpoint allows your application to delete system.
- [Read System](https://docs.omneo.io/api-reference/system/read-system.md): A `GET` to the `/systems/{system}` endpoint allows your application to retrieve system.
- [Add Tag](https://docs.omneo.io/api-reference/tag/add-tag.md): A `POST` to the `/tags` endpoint allows your application to create tag.
- [Browse Tags](https://docs.omneo.io/api-reference/tag/browse-tags.md): A `GET` to the `/tags` endpoint allows your application to retrieve tags.
- [Delete Tag](https://docs.omneo.io/api-reference/tag/delete-tag.md): A `DELETE` to the `/tags/{tag}` endpoint allows your application to delete tag.
- [Read Tag](https://docs.omneo.io/api-reference/tag/read-tag.md): A `GET` to the `/tags/{tag}` endpoint allows your application to retrieve tag.
- [Add a Target](https://docs.omneo.io/api-reference/target/add-a-target.md): A `POST` to the `/target` endpoint allows your application to create a Target.
- [Browse Targets](https://docs.omneo.io/api-reference/target/browse-targets.md): A `GET` to the `/targets` endpoint allows your application to retrieve all a tenants Targets.
- [Delete the Target](https://docs.omneo.io/api-reference/target/delete-the-target.md): A `DELETE` to the `/targets/{targetId}` endpoint allows your application to delete a Target.
- [Edit a Target](https://docs.omneo.io/api-reference/target/edit-a-target.md): A `PUT` to the `/targets/{targetId}` endpoint allows your application to edit a specific Target.
- [Targets](https://docs.omneo.io/api-reference/target/overview.md)
- [Read a Target](https://docs.omneo.io/api-reference/target/read-a-target.md): A `GET` to the `/targets/{targetId}` endpoint allows your application to retrieve a specific Target.
- [Add Tenant Custom Field](https://docs.omneo.io/api-reference/tenant-custom-field/add-tenant-custom-field.md): A `POST` to the `/tenants/custom-fields` endpoint allows your application to create tenant custom field.
- [Browse Tenant Custom Field Versions](https://docs.omneo.io/api-reference/tenant-custom-field/browse-tenant-custom-field-versions.md): A `GET` to the `/tenants/custom-fields/{customField}/versions` endpoint allows your application to retrieve all versions of a tenant custom field.
- [Browse Tenant Custom Fields](https://docs.omneo.io/api-reference/tenant-custom-field/browse-tenant-custom-fields.md): A `GET` to the `/tenants/custom-fields` endpoint allows your application to retrieve tenant custom fields.
- [Delete Tenant Custom Field](https://docs.omneo.io/api-reference/tenant-custom-field/delete-tenant-custom-field.md): A `DELETE` to the `/tenants/custom-fields/{custom_field}` endpoint allows your application to delete tenant custom field.
- [Edit Tenant Custom Field](https://docs.omneo.io/api-reference/tenant-custom-field/edit-tenant-custom-field.md): A `PUT` to the `/tenants/custom-fields/{custom_field}` endpoint allows your application to edit tenant custom field.
- [Read Tenant Custom Field](https://docs.omneo.io/api-reference/tenant-custom-field/read-tenant-custom-field.md): A `GET` to the `/tenants/custom-fields/{custom_field}` endpoint allows your application to retrieve tenant custom field.
- [Trigger Tenant Custom Event](https://docs.omneo.io/api-reference/tenant/trigger-tenant-custom-event.md): A `POST` to the `/tenants/custom-event` endpoint allows your application to trigger tenant custom event.
- [Add Tier Definition](https://docs.omneo.io/api-reference/tier-definition/add-tier-definition.md): A `POST` to the `/tiers/definitions` endpoint allows your application to create a Tier Definition.
- [Browse Tier Definitions](https://docs.omneo.io/api-reference/tier-definition/browse-tier-definitions.md): A `GET` to the `/tiers/definitions` endpoint allows your application to retrieve all a tenants a Tier Definitions.
- [Delete Tier Definition](https://docs.omneo.io/api-reference/tier-definition/delete-tier-definition.md): A `DELETE` to the `/tiers/definitions/{tierDefinitionId}` endpoint allows your application to delete a Tier Definition.
- [Edit Tier Definition](https://docs.omneo.io/api-reference/tier-definition/edit-tier-definition.md): A `PUT` to the `/tiers/definitions/{tierDefinitionId}` endpoint allows your application to edit a Tier Definition.
- [Tier Definitions](https://docs.omneo.io/api-reference/tier-definition/overview.md)
- [Read Tier Definition](https://docs.omneo.io/api-reference/tier-definition/read-tier-definition.md): A `GET` to the `/tiers/definitions/{tierDefinitionId}` endpoint allows your application to retrieve a specific Tier Definition.
- [Add Tier Point](https://docs.omneo.io/api-reference/tier-point/add-tier-point.md): A `POST` to the `/tiers/points` endpoint allows your application to create tier point.
- [Browse Tier Points](https://docs.omneo.io/api-reference/tier-point/browse-tier-points.md): A `GET` to the `/tiers/points` endpoint allows your application to retrieve tier points.
- [Delete Tier Point](https://docs.omneo.io/api-reference/tier-point/delete-tier-point.md): A `DELETE` to the `/tiers/points/{point}` endpoint allows your application to delete tier point.
- [Read Tier Point](https://docs.omneo.io/api-reference/tier-point/read-tier-point.md): A `GET` to the `/tiers/points/{point}` endpoint allows your application to retrieve tier point.
- [Add Transaction Custom Field](https://docs.omneo.io/api-reference/transaction-custom-field/add-transaction-custom-field.md): A `POST` to the `/transactions/{transaction}/custom-fields` endpoint allows your application to create transaction custom field.
- [Browse Transaction Custom Fields](https://docs.omneo.io/api-reference/transaction-custom-field/browse-transaction-custom-fields.md): A `GET` to the `/transactions/{transaction}/custom-fields` endpoint allows your application to retrieve transaction custom fields.
- [Delete Transaction Custom Field](https://docs.omneo.io/api-reference/transaction-custom-field/delete-transaction-custom-field.md): A `DELETE` to the `/transactions/{transaction}/custom-fields/{custom_field}` endpoint allows your application to delete transaction custom field.
- [Edit Transaction Custom Field](https://docs.omneo.io/api-reference/transaction-custom-field/edit-transaction-custom-field.md): A `PUT` to the `/transactions/{transaction}/custom-fields/{custom_field}` endpoint allows your application to edit transaction custom field.
- [Read Transaction Custom Field](https://docs.omneo.io/api-reference/transaction-custom-field/read-transaction-custom-field.md): A `GET` to the `/transactions/{transaction}/custom-fields/{custom_field}` endpoint allows your application to retrieve transaction custom field.
- [Add Transaction Item](https://docs.omneo.io/api-reference/transaction-item/add-transaction-item.md): A `GET` to the `/transactions/{transactionId}/items` endpoint allows your application to add an Item (Products) to a Transaction record.
- [Browse Transaction Items](https://docs.omneo.io/api-reference/transaction-item/browse-transaction-items.md): A `GET` to the `/transactions/{transactionId}/items` endpoint allows your application to retrieve all Items (Products) associated with a Transaction.
- [Delete a transaction item](https://docs.omneo.io/api-reference/transaction-item/delete-a-transaction-item.md): A `DELETE` to the `/transactions/{transactionId}/items/{itemId}` endpoint allows your application to delete a Transaction Item.
- [Link Profile Transaction Item to List Item](https://docs.omneo.io/api-reference/transaction-item/link-profile-transaction-item-to-list-item.md): A `POST` to the `/profiles/{profile}/transactions/items/{transactionitem}/list-item` endpoint allows your application to link profile transaction item to list item.
- [Link Transaction Item to List Item](https://docs.omneo.io/api-reference/transaction-item/link-transaction-item-to-list-item.md): A `POST` to the `/transactions/items/{transactionitem}/list-item` endpoint allows your application to link transaction item to list item.
- [Transaction Items](https://docs.omneo.io/api-reference/transaction-item/overview.md)
- [Read Transaction Item](https://docs.omneo.io/api-reference/transaction-item/read-transaction-item.md): A `GET` to the `/transactions/{transactionId}/items/{itemId}` endpoint allows your application to a specific Transation Item associated with a Transaction record.
- [Recalculate Transaction Item Achievement Points](https://docs.omneo.io/api-reference/transaction-item/recalculate-transaction-item-achievement-points.md): A `PUT` to the `/transactions/items/{transactionitem}` endpoint allows your application to recalculate transaction item achievement points.
- [Resend Transaction Item Payload](https://docs.omneo.io/api-reference/transaction-item/resend-transaction-item-payload.md): A `POST` to the `/transactions/items/{transactionitem}/resend` endpoint allows your application to resend transaction item payload.
- [Add Transaction](https://docs.omneo.io/api-reference/transaction/add-transaction.md): A `POST` to the `/transactions` endpoint allows your application to create a Transaction.
- [Batch Transactions](https://docs.omneo.io/api-reference/transaction/batch-transactions.md): A `POST` to the `/transactions/batch.json` endpoint allows your application to process transactions in batch.
- [Browse Transactions](https://docs.omneo.io/api-reference/transaction/browse-transactions.md): A `GET` to the `/transactions` endpoint allows your application to retrieve all a tenants Transactions.
- [Create or Update a Transaction](https://docs.omneo.io/api-reference/transaction/create-or-update-a-transaction.md): A `POST` to the `/transactions/update-create` endpoint allows your application to create or update a Transaction.
- [Delete Transaction](https://docs.omneo.io/api-reference/transaction/delete-transaction.md): A `DELETE` to the `/transactions/{transactionId}` endpoint allows your application to delete a Transaction record.
- [Edit Transaction](https://docs.omneo.io/api-reference/transaction/edit-transaction.md): A `PUT` to the `/transactions/{transactionId}` endpoint allows your application to edit a Transaction associated with a Profile.
- [Estimate Incentives](https://docs.omneo.io/api-reference/transaction/estimate-incentives.md): A `POST` to the `/transactions/incentive-estimate` endpoint allows your application to estimate incentives for a mock transaction without persisting it.
- [Transactions](https://docs.omneo.io/api-reference/transaction/overview.md): Immutable completed purchase records that drive aggregations, points, and reactions.
- [Queue Transaction](https://docs.omneo.io/api-reference/transaction/queue-transaction.md): A `POST` to the `/transactions/queue` endpoint allows your application to create a Transaction by adding to the process queue.
- [Queue Transaction Create Request](https://docs.omneo.io/api-reference/transaction/queue-transaction-create-request.md): A `POST` to the `/transactions/queue/create` endpoint allows your application to queue transaction create request.
- [Read Transaction](https://docs.omneo.io/api-reference/transaction/read-transaction.md): A `GET` to the `/transactions/{transactionId}` endpoint allows your application to retrieve a specific Transaction record.
- [Read Transaction by External ID](https://docs.omneo.io/api-reference/transaction/read-transaction-by-external-id.md): A `GET` to the `/transactions/external/{id}` endpoint allows your application to retrieve a specific Transaction record by its external_id.
- [Resend Transaction Payload](https://docs.omneo.io/api-reference/transaction/resend-transaction-payload.md): A `POST` to the `/transactions/{id}/resend` endpoint allows your application to resend transaction payload.
- [Trigger Transaction Event](https://docs.omneo.io/api-reference/transaction/trigger-transaction-event.md): A `POST` to the `/transactions/{transactionId}/event-trigger` endpoint allows your application to trigger permitted events for a Transaction.
- [Get a fresh transient token cookie for the authenticated user](https://docs.omneo.io/api-reference/transient-token/get-a-fresh-transient-token-cookie-for-the-authenticated-user.md)
- [Add a trigger action](https://docs.omneo.io/api-reference/trigger-action/add-a-trigger-action.md): A `POST` to the `/triggers/{triggerId}/actions` endpoint allows your application to add a specific trigger action
- [Delete the trigger action](https://docs.omneo.io/api-reference/trigger-action/delete-the-trigger-action.md): A `DELETE` to the `/triggers/{triggerId}/actions/{actionId}` endpoint allows your application to delete an trigger action.
- [Read a specific trigger action](https://docs.omneo.io/api-reference/trigger-action/read-a-specific-trigger-action.md): A `GET` to the `/triggers/{triggerId}/actions/{actionId}` endpoint allows your application to retrieve a specific trigger action.
- [Read trigger actions](https://docs.omneo.io/api-reference/trigger-action/read-trigger-actions.md): A `GET` to the `/triggers/{triggerId}/actions` endpoint allows your application to retrieve actions for a specific trigger.
- [Update an Trigger action](https://docs.omneo.io/api-reference/trigger-action/update-an-trigger-action.md): A `PUT` to the `/triggers/{triggerId}/actions/{actionId}` endpoint allows your application to update a specific trigger action
- [Add a trigger](https://docs.omneo.io/api-reference/trigger/add-a-trigger.md): A `POST` to the `/trigger` endpoint allows your application to create a trigger.
- [Browse triggers](https://docs.omneo.io/api-reference/trigger/browse-triggers.md): A `GET` to the `/triggers` endpoint allows your application to retrieve all a tenants triggers.
- [Delete the trigger](https://docs.omneo.io/api-reference/trigger/delete-the-trigger.md): A `DELETE` to the `/triggers/{triggerId}` endpoint allows your application to delete an trigger.
- [Edit Trigger](https://docs.omneo.io/api-reference/trigger/edit-trigger.md): A `PUT` to the `/triggers/{triggerId}` endpoint allows your application to edit trigger.
- [Triggers](https://docs.omneo.io/api-reference/trigger/overview.md): Event-driven reactions that fire when a specific Omneo event occurs.
- [Read a trigger](https://docs.omneo.io/api-reference/trigger/read-a-trigger.md): A `GET` to the `/triggers/{triggerId}` endpoint allows your application to retrieve a specific trigger.
- [Add a user](https://docs.omneo.io/api-reference/user/add-a-user.md): A `POST` to the `/user` endpoint allows your application to create a user.
- [Browse users](https://docs.omneo.io/api-reference/user/browse-users.md): A `GET` to the `/users` endpoint allows your application to retrieve all a tenants users.
- [Delete the user](https://docs.omneo.io/api-reference/user/delete-the-user.md): A `DELETE` to the `/users/{userId}` endpoint allows your application to delete a user.
- [Edit a user](https://docs.omneo.io/api-reference/user/edit-a-user.md): A `PUT` to the `/users/{userId}` endpoint allows your application to edit a specific user.
- [Read a user](https://docs.omneo.io/api-reference/user/read-a-user.md): A `GET` to the `/users/{userId}` endpoint allows your application to retrieve a specific user.
- [Read the authenticated user](https://docs.omneo.io/api-reference/user/read-the-authenticated-user.md): A `GET` to the `/users/me` endpoint allows your application to retrieve the current authenticated user.
- [Add a Webhook](https://docs.omneo.io/api-reference/webhook/add-a-webhook.md): A `POST` to the `/Webhook` endpoint allows your application to create a Webhook.
- [Batch Webhooks](https://docs.omneo.io/api-reference/webhook/batch-webhooks.md): A `POST` to the `/webhooks/batch.json` endpoint allows your application to process webhooks in batch.
- [Browse webhooks](https://docs.omneo.io/api-reference/webhook/browse-webhooks.md): A `GET` to the `/webhooks` endpoint allows your application to retrieve all a tenants webhooks.
- [Delete the Webhook](https://docs.omneo.io/api-reference/webhook/delete-the-webhook.md): A `DELETE` to the `/webhooks/{WebhookId}` endpoint allows your application to delete a Webhook.
- [Edit a Webhook](https://docs.omneo.io/api-reference/webhook/edit-a-webhook.md): A `PUT` to the `/webhooks/{WebhookId}` endpoint allows your application to edit a specific Webhook.
- [Read a Webhook](https://docs.omneo.io/api-reference/webhook/read-a-webhook.md): A `GET` to the `/webhooks/{WebhookId}` endpoint allows your application to retrieve a specific Webhook.
- [CSAT and NPS](https://docs.omneo.io/business-guides/cx-measurement/csat-nps.md): Using customer satisfaction metrics in your Omneo CX program.
- [eReceipts](https://docs.omneo.io/business-guides/cx-measurement/ereceipts.md): Using Omneo-powered eReceipts to reduce costs and improve the post-purchase experience.
- [What is a MAU?](https://docs.omneo.io/business-guides/cx-measurement/what-is-a-mau.md): Understanding Monthly Active Users in the context of Omneo and why they matter for CX measurement.
- [Comms Preference Centre](https://docs.omneo.io/business-guides/extensions/comms-preference-centre.md): How the Omneo comms preference centre works and how customers manage their communication preferences.
- [Cross-Brand Profiles](https://docs.omneo.io/business-guides/extensions/cross-brand-profiles.md): How Cross-Brand Profiles work and when to use them for multi-brand retail groups.
- [Qantas Frequent Flyer](https://docs.omneo.io/business-guides/extensions/qantas-frequent-flyer.md): How the Qantas Frequent Flyer integration works with Omneo.
- [Shopify for Merchants](https://docs.omneo.io/business-guides/extensions/shopify-for-merchants.md): What the Omneo Shopify integration does for your brand and how to get the most from it.
- [Zendesk for CS Teams](https://docs.omneo.io/business-guides/extensions/zendesk-for-cs-teams.md): How the Omneo Zendesk integration works and what it gives your customer service team.
- [Achievements](https://docs.omneo.io/business-guides/incentive-design/achievements.md): Designing and using Achievements in your Omneo incentive program.
- [Benefits](https://docs.omneo.io/business-guides/incentive-design/benefits.md): Designing and using Benefits in your Omneo incentive program.
- [Credits](https://docs.omneo.io/business-guides/incentive-design/credits.md): How Credits work in an Omneo incentive program and when to use them.
- [Introduction to Incentive Programs](https://docs.omneo.io/business-guides/incentive-design/introduction.md): What Omneo incentive programs are, how they work, and why they matter for retail CX.
- [Points Programs](https://docs.omneo.io/business-guides/incentive-design/points-programs.md): Designing and configuring a points-based incentive program in Omneo.
- [Program Objectives](https://docs.omneo.io/business-guides/incentive-design/program-objectives.md): Defining clear objectives for your Omneo incentive program before designing the mechanics.
- [Redemption Strategies](https://docs.omneo.io/business-guides/incentive-design/redemption-strategies.md): Designing how and when customers redeem their incentives in Omneo.
- [Rewards — Spend and Get](https://docs.omneo.io/business-guides/incentive-design/rewards-spend-and-get.md): Designing spend-and-get reward mechanics in Omneo.
- [Tier Programs](https://docs.omneo.io/business-guides/incentive-design/tier-programs.md): Designing and configuring a tiered incentive program in Omneo.
- [Setting Up Your Customer Service Team](https://docs.omneo.io/business-guides/managing-your-instance/customer-service-team.md): How to onboard and equip your customer service team to manage Omneo profiles effectively.
- [Is Omneo Right for Us?](https://docs.omneo.io/business-guides/managing-your-instance/is-omneo-right.md): A quick guide to evaluating whether Omneo is the right CX platform for your retail business.
- [QA and Testing](https://docs.omneo.io/business-guides/managing-your-instance/qa-testing.md): How to test your Omneo configuration before going live — staging environments, test profiles, and end-to-end flows.
- [Security](https://docs.omneo.io/business-guides/managing-your-instance/security.md): Security practices for managing your Omneo instance — access control, tokens, and data handling.
- [Setting Up for Success](https://docs.omneo.io/business-guides/managing-your-instance/setting-up-for-success.md): Pre-launch checklist and key decisions to make before going live with Omneo.
- [Connecting a Comms Platform](https://docs.omneo.io/business-guides/notifications/connecting-comms-platform.md): How to connect your email and SMS platform to Omneo to send incentive and CX notifications.
- [Incentive Notifications](https://docs.omneo.io/business-guides/notifications/incentive-notifications.md): How to notify customers about earned rewards, tier changes, and expiring incentives.
- [Age and Date of Birth](https://docs.omneo.io/business-guides/profile-design/age.md): How Omneo stores age and DOB data, and how to use it for personalisation.
- [Email and Mobile Consent](https://docs.omneo.io/business-guides/profile-design/email-mobile-consent.md): Managing marketing consent in Omneo — opt-ins, opt-outs, and comms preferences.
- [Gender](https://docs.omneo.io/business-guides/profile-design/gender.md): How Omneo handles the gender profile field and considerations for inclusive data capture.
- [Passwords and Authentication](https://docs.omneo.io/business-guides/profile-design/passwords.md): How customer authentication works for Profile Portal and account access.
- [Payment Preferences](https://docs.omneo.io/business-guides/profile-design/payment.md): Using Omneo to track and personalise based on customer payment behaviour.
- [Personalisation](https://docs.omneo.io/business-guides/profile-design/personalisation.md): Using Omneo profile data to deliver personalised experiences across channels.
- [Progressive Profiling](https://docs.omneo.io/business-guides/profile-design/progressive-profiling.md): How to design a profile data strategy that grows customer data over time without friction.
- [Claiming a Transaction](https://docs.omneo.io/business-guides/profiles/claim-transaction.md): How to attribute an unlinked transaction to a customer profile after the fact.
- [Managing Profiles in Clienteling](https://docs.omneo.io/business-guides/profiles/managing-in-clienteling.md): How in-store staff use Clienteling to look up, create, and service customer profiles.
- [Managing Profiles in CX Manager](https://docs.omneo.io/business-guides/profiles/managing-in-cx-manager.md): How to search, view, edit, and manage customer profiles in Omneo CX Manager.
- [Managing Profiles in Profile Portal](https://docs.omneo.io/business-guides/profiles/managing-in-profile-portal.md): How customers manage their own profile through the Omneo Profile Portal.
- [Merging Profiles](https://docs.omneo.io/business-guides/profiles/merging-profiles.md): When and how to merge duplicate customer profiles in Omneo.
- [Managing Visits](https://docs.omneo.io/business-guides/visits/managing-visits.md): How Visits work in Omneo and how to use them in your CX program.
- [Reactions](https://docs.omneo.io/concepts/automation/reactions.md): Omneo's automation engine — event-driven triggers and scheduled automations.
- [Targets](https://docs.omneo.io/concepts/automation/targets.md): Configured endpoints that receive formatted JSON payloads from Omneo reactions.
- [Webhooks](https://docs.omneo.io/concepts/automation/webhooks.md): HTTP callbacks that Omneo sends to external systems when events occur.
- [Credits](https://docs.omneo.io/concepts/commerce/credits.md): Credits are a payment object in Omneo — store credit, promotional credit, and gift cards.
- [Locations](https://docs.omneo.io/concepts/commerce/locations.md): Store and location records used to contextualise transactions, profiles, and personalisation.
- [Orders](https://docs.omneo.io/concepts/commerce/orders.md): Unfinalised purchase records that can become one or many transactions.
- [Products](https://docs.omneo.io/concepts/commerce/products.md): Product records in Omneo used in transactions, lists, and personalisation.
- [Transactions](https://docs.omneo.io/concepts/commerce/transactions.md): Completed, immutable purchase or return records linked to a customer profile.
- [BI & CDP Extensions](https://docs.omneo.io/concepts/extensions/bi-cdp.md): Connecting Omneo to business intelligence tools and customer data platforms.
- [Communications Extensions](https://docs.omneo.io/concepts/extensions/comms.md): How Omneo syncs with email and SMS marketing platforms.
- [Customer Service Extensions](https://docs.omneo.io/concepts/extensions/customer-service.md): How Omneo integrates with Zendesk and Gorgias to surface profile data in support tickets.
- [eCommerce Extensions](https://docs.omneo.io/concepts/extensions/ecommerce.md): How Omneo integrates with Shopify, SFCC, Magento, BigCommerce, and other eCommerce platforms.
- [ERP & POS Extensions](https://docs.omneo.io/concepts/extensions/erp-pos.md): Connecting Omneo to in-store point-of-sale and ERP systems.
- [Loyalty Partner Extensions](https://docs.omneo.io/concepts/extensions/loyalty-partners.md): Connecting Omneo profiles to third-party incentive programs like Qantas Frequent Flyer.
- [Extensions Overview](https://docs.omneo.io/concepts/extensions/overview.md)
- [Glossary](https://docs.omneo.io/concepts/glossary.md): Key concepts and terminology used across the Omneo platform and documentation.
- [Achievements](https://docs.omneo.io/concepts/incentives/achievements.md): Gamified milestone tracking that rewards customers for cumulative engagement with the brand.
- [Benefits](https://docs.omneo.io/concepts/incentives/benefits.md): Non-monetary incentives including vouchers, discounts, perks, and entitlements.
- [Issue, Claim, Extend, Redeem](https://docs.omneo.io/concepts/incentives/issue-claim-extend-redeem.md): The four key lifecycle events for incentives in Omneo.
- [Incentives Overview](https://docs.omneo.io/concepts/incentives/overview.md)
- [Points](https://docs.omneo.io/concepts/incentives/points.md): An abstract currency earned through purchases and actions, redeemable for incentives.
- [Rewards](https://docs.omneo.io/concepts/incentives/rewards.md): Dollar-value discounts with expiry dates — the foundation of spend-based incentive programs.
- [Statuses](https://docs.omneo.io/concepts/incentives/statuses.md): Named profile labels that categorise customers and modify their incentive entitlements.
- [Incentive Targets](https://docs.omneo.io/concepts/incentives/targets.md): How Targets are used to send incentive notifications to comms platforms.
- [Tiers](https://docs.omneo.io/concepts/incentives/tiers.md): Annualised tier programs that reward your most engaged customers with elevated status and benefits.
- [List Definitions](https://docs.omneo.io/concepts/lists/list-definitions.md): Templates that define the type and rules of product lists in Omneo.
- [List Reservations](https://docs.omneo.io/concepts/lists/list-reservations.md): Reserving list items to indicate intent to purchase or gift.
- [New to You](https://docs.omneo.io/concepts/lists/new-to-you.md): System-generated personalised product recommendations based on a customer's purchase history.
- [Lists Overview](https://docs.omneo.io/concepts/lists/overview.md)
- [Organisations](https://docs.omneo.io/concepts/organisations/organisations.md): External entities — schools, corporates, suppliers — linked to profiles via Roles.
- [Roles and Permissions](https://docs.omneo.io/concepts/organisations/roles-and-permissions.md): How roles define the relationship between profiles and organisations.
- [Clienteling](https://docs.omneo.io/concepts/platform-surfaces/clienteling.md): The staff-facing in-store profile surface for personalised customer service.
- [CX Manager](https://docs.omneo.io/concepts/platform-surfaces/cx-manager.md): The Omneo admin web UI — the primary interface for configuring and managing the platform.
- [Omneo SDK](https://docs.omneo.io/concepts/platform-surfaces/omneo-sdk.md): The JavaScript SDK for building Omneo-powered experiences on the web.
- [Omneo Wallet (Omneo Pass)](https://docs.omneo.io/concepts/platform-surfaces/omneo-wallet.md): Apple Wallet and Google Wallet integration for digital loyalty cards.
- [Profile Portal](https://docs.omneo.io/concepts/platform-surfaces/profile-portal.md): The customer-facing self-service web app for managing profiles, viewing incentives, and more.
- [Addresses](https://docs.omneo.io/concepts/profiles/addresses.md): How Omneo stores and manages customer address records linked to profiles.
- [Aggregations](https://docs.omneo.io/concepts/profiles/aggregations.md): Calculated profile facts derived from transaction and interaction history.
- [Appearance Attributes](https://docs.omneo.io/concepts/profiles/appearance-attributes.md): Physical measurements and style preferences stored on a customer profile.
- [Comms Preferences](https://docs.omneo.io/concepts/profiles/comms-preferences.md): How Omneo stores and manages customer communication preferences and opt-in status.
- [Connections](https://docs.omneo.io/concepts/profiles/connections.md): Profile-to-profile relationships in Omneo using the Definition/Instance pattern.
- [Core profile fields](https://docs.omneo.io/concepts/profiles/core-fields.md): The default fields available on every Omneo Profile record.
- [Custom attributes](https://docs.omneo.io/concepts/profiles/custom-attributes.md): Brand-defined fields that extend the Omneo profile schema beyond the defaults.
- [Deletions, purges, and depersonalisation](https://docs.omneo.io/concepts/profiles/deletions-purges-depersonalisations.md): The three ways a profile can be removed or anonymised in Omneo, and when to use each.
- [Identities](https://docs.omneo.io/concepts/profiles/identities.md): Profile Identities link a customer's Omneo profile to their IDs in external systems, enabling a true single view of the customer across every platform.
- [Localisation](https://docs.omneo.io/concepts/profiles/localisation.md): How Omneo handles regions, currencies, timezones, and language across profiles, locations, and organisations.
- [Profiles](https://docs.omneo.io/concepts/profiles/overview.md): The central customer record in Omneo. Every transaction, incentive, and interaction links back to a Profile.
- [Tags and statuses](https://docs.omneo.io/concepts/profiles/tags-and-statuses.md): Tags and statuses allow brands to label and categorise profiles for operational and incentive purposes.
- [CSAT](https://docs.omneo.io/concepts/ratings/csat.md): Customer Satisfaction Score — measuring satisfaction after specific interactions.
- [Location Ratings](https://docs.omneo.io/concepts/ratings/location-ratings.md): Customer ratings of store and location experiences.
- [NPS](https://docs.omneo.io/concepts/ratings/nps.md): Net Promoter Score — measuring overall brand loyalty and likelihood to recommend.
- [Product Ratings](https://docs.omneo.io/concepts/ratings/product-ratings.md): Customer ratings and reviews linked to specific products in their purchase history.
- [Visits](https://docs.omneo.io/concepts/visits.md): Tracking customer presence and appointments at physical locations.
- [Creating Transactions](https://docs.omneo.io/dev-guides/commerce/creating-transactions.md): How to record completed transactions in Omneo via the API — single, upsert, and bulk patterns.
- [Working with Credits](https://docs.omneo.io/dev-guides/commerce/working-with-credits.md): Issuing, reading, and redeeming Omneo Credits via the API.
- [Working with Orders](https://docs.omneo.io/dev-guides/commerce/working-with-orders.md): Creating and managing Orders in Omneo — the mutable pre-transaction record.
- [API Tokens](https://docs.omneo.io/dev-guides/core-setup/api-tokens.md): Generating and managing bearer tokens for API authentication.
- [Authentication](https://docs.omneo.io/dev-guides/core-setup/authentication.md): How to authenticate with the Omneo API using OAuth 2.0 or bearer tokens.
- [Omneo CLI](https://docs.omneo.io/dev-guides/core-setup/cli.md): Command-line interface for Omneo — coming soon.
- [Global vs profile-scoped endpoints](https://docs.omneo.io/dev-guides/core-setup/global-vs-profile-routes.md): When to use a resource's global endpoint versus its profile-scoped counterpart.
- [Omneo MCP](https://docs.omneo.io/dev-guides/core-setup/mcp.md): Model Context Protocol server for Omneo — coming soon.
- [Postman](https://docs.omneo.io/dev-guides/core-setup/postman.md): Getting started with the Omneo Postman collection for API exploration.
- [Omneo SDK](https://docs.omneo.io/dev-guides/core-setup/sdk.md): The JavaScript SDK for building Omneo-powered front-end experiences.
- [BigCommerce](https://docs.omneo.io/dev-guides/extensions/bigcommerce.md): Integrating Omneo with BigCommerce.
- [Commerce Layer](https://docs.omneo.io/dev-guides/extensions/commerce-layer.md): Integrating Omneo with Commerce Layer.
- [commercetools](https://docs.omneo.io/dev-guides/extensions/commercetools.md): Integrating Omneo with commercetools.
- [Corporate Invites](https://docs.omneo.io/dev-guides/extensions/corporate-invites.md): Configuring the Omneo Corporate Invites portal for partner or employee sign-up flows.
- [Gorgias](https://docs.omneo.io/dev-guides/extensions/gorgias.md): Setting up the Omneo Gorgias integration to surface customer data in Gorgias tickets.
- [Magento / Adobe Commerce](https://docs.omneo.io/dev-guides/extensions/magento.md): Integrating Omneo with Magento 2 / Adobe Commerce.
- [Salesforce Commerce Cloud](https://docs.omneo.io/dev-guides/extensions/sfcc.md): Integrating Omneo with Salesforce Commerce Cloud (SFCC).
- [Shopify Extension](https://docs.omneo.io/dev-guides/extensions/shopify.md): How the Omneo Shopify extension syncs profiles, orders, products, and transactions between Omneo and Shopify.
- [Shopify Checkout Rewards](https://docs.omneo.io/dev-guides/extensions/shopify-checkout-rewards.md): Integrating the Omneo reward redemption component into Shopify checkout.
- [Shopify Proxy](https://docs.omneo.io/dev-guides/extensions/shopify-proxy.md): Using the Omneo Shopify Proxy to make authenticated front-end requests without exposing API tokens.
- [Zendesk App](https://docs.omneo.io/dev-guides/extensions/zendesk-app.md): Setting up the Omneo Zendesk plugin to surface customer data and sync interactions.
- [Barcodes](https://docs.omneo.io/dev-guides/frontend/barcodes.md): Generating Omneo-authenticated barcodes for embedding in emails, web pages, and digital passes.
- [Displaying transactions](https://docs.omneo.io/dev-guides/frontend/displaying-transactions.md): Retrieving and rendering a profile's transaction history using the Omneo SDK.
- [Facebook Offline Events](https://docs.omneo.io/dev-guides/frontend/facebook-offline-events.md): Syncing Omneo in-store transactions to a Meta (Facebook) offline event dataset.
- [Invites Plugin](https://docs.omneo.io/dev-guides/frontend/invites-plugin.md): Setting up the Omneo Invites plugin for referral and invite-based member acquisition.
- [Meta Lead Ads](https://docs.omneo.io/dev-guides/frontend/meta-leads-ads.md): Syncing Meta Lead Ads submissions to Omneo profiles automatically.
- [Omneo ID](https://docs.omneo.io/dev-guides/frontend/omneo-id.md): Using the Omneo ID proxy service to generate profile-scoped tokens for front-end use.
- [Omneo SDK (Shapes SDK)](https://docs.omneo.io/dev-guides/frontend/omneo-sdk.md): Initialising and using the Shapes SDK to interact with profile data in front-end applications.
- [Using the Omneo SDK](https://docs.omneo.io/dev-guides/frontend/using-omneo-sdk.md): Common patterns for initialising the Omneo SDK and working with profile data in front-end applications.
- [Claimable Benefits — eCommerce](https://docs.omneo.io/dev-guides/incentives/claimable-benefits-ecommerce.md): How to surface and redeem Omneo benefits at online checkout.
- [Creating a benefit definition](https://docs.omneo.io/dev-guides/incentives/creating-a-benefit-definition.md): Setting up a Benefit Definition via the API before issuing or offering benefits to profiles.
- [Creating a reward definition](https://docs.omneo.io/dev-guides/incentives/creating-a-reward-definition.md): Setting up a Reward Definition via the API before issuing rewards to profiles.
- [Estimating incentives](https://docs.omneo.io/dev-guides/incentives/estimating-incentives.md): Simulate what incentives a transaction would earn before committing it to Omneo.
- [Importing Rewards](https://docs.omneo.io/dev-guides/incentives/importing-rewards.md): How to issue rewards to profiles programmatically — definitions, issuance, redemption, and bulk import.
- [Requesting benefits](https://docs.omneo.io/dev-guides/incentives/requesting-benefits.md): Retrieving issued and claimable benefits for a profile via the API.
- [Using Rates](https://docs.omneo.io/dev-guides/incentives/using-rates.md): Configure Point Definition Rates to control how many points a profile earns per transaction.
- [Working with Benefits](https://docs.omneo.io/dev-guides/incentives/working-with-benefits.md): Creating benefit definitions, issuing benefits to profiles, and recording redemptions via the API.
- [List Definitions](https://docs.omneo.io/dev-guides/lists/list-definitions.md): Creating and configuring List Definitions that govern the behaviour of product lists.
- [List Reservations](https://docs.omneo.io/dev-guides/lists/list-reservations.md): Reserving items on shared product lists via the Omneo API.
- [Product List Items](https://docs.omneo.io/dev-guides/lists/product-list-items.md): Adding, updating, and removing items from a product list via the Omneo API.
- [Working with Product Lists](https://docs.omneo.io/dev-guides/lists/working-with-product-lists.md): Creating and managing personalised product lists (wishlists, gift registries) in Omneo.
- [POS Integration Overview](https://docs.omneo.io/dev-guides/pos/overview.md)
- [POS Integration Guide](https://docs.omneo.io/dev-guides/pos/pos-integration-guide.md): Step-by-step API integration guide for connecting a Point of Sale system directly to Omneo.
- [Addresses](https://docs.omneo.io/dev-guides/profiles/addresses.md): Managing profile addresses via the Omneo API — add, update, and set defaults.
- [Filtering profiles](https://docs.omneo.io/dev-guides/profiles/filtering-profiles.md): Querying the profiles list endpoint with filters to find profiles matching specific criteria.
- [Merging Profiles](https://docs.omneo.io/dev-guides/profiles/merging-profiles.md): How to merge duplicate profiles in Omneo — the Winner/Loser pattern.
- [Profile blacklist and opt-out](https://docs.omneo.io/dev-guides/profiles/profile-blacklist.md): Using tags, statuses, and comms opt-out fields to suppress a profile from communications and operations.
- [Tags](https://docs.omneo.io/dev-guides/profiles/tags.md): Adding, updating, filtering, and searching profile tags via the Omneo API.
- [Users and Permissions](https://docs.omneo.io/dev-guides/profiles/users-and-permissions.md): Creating and managing CX Manager users and their role-based permissions.
- [Working with Aggregations](https://docs.omneo.io/dev-guides/profiles/working-with-aggregations.md): Reading and using profile aggregation data via the Omneo API.
- [Working with Identities](https://docs.omneo.io/dev-guides/profiles/working-with-identities.md): Adding, reading, and searching profile identities via the Omneo API.
- [Working with Profiles](https://docs.omneo.io/dev-guides/profiles/working-with-profiles.md): Creating, reading, updating, and searching profiles via the Omneo API.
- [Example Reaction](https://docs.omneo.io/dev-guides/reactions/example-reaction.md): A complete walkthrough of building a reaction that issues a benefit when a profile achieves a specific tier.
- [Reaction Filters](https://docs.omneo.io/dev-guides/reactions/filters.md): Using filter actions to conditionally gate reaction chains in Omneo.
- [JSON Conditions](https://docs.omneo.io/dev-guides/reactions/json-conditions.md): Writing JSON Logic conditions for reaction filters and claimable benefit eligibility in Omneo.
- [Reactions Overview](https://docs.omneo.io/dev-guides/reactions/overview.md)
- [Targets](https://docs.omneo.io/dev-guides/reactions/targets.md): Configuring Omneo Targets to send Twig-templated JSON payloads to external endpoints via reactions.
- [Working with Visits](https://docs.omneo.io/dev-guides/visits/working-with-visits.md): Recording and managing customer visits in Omneo via the API.
- [Custom Events](https://docs.omneo.io/dev-guides/webhooks/custom-events.md): Firing custom events in Omneo to trigger reactions from external systems.
- [Event Contexts](https://docs.omneo.io/dev-guides/webhooks/event-contexts.md): Understanding the richer Event Context payloads returned in webhooks and reactions.
- [Webhooks](https://docs.omneo.io/dev-guides/webhooks/webhooks.md): Receiving and processing Omneo event webhooks in your integration.
- [Clienteling changelog](https://docs.omneo.io/experiences/clienteling/changelog.md): Release history and upcoming changes for Clienteling.
- [Configuring Clienteling](https://docs.omneo.io/experiences/clienteling/configuration.md): How to set up Clienteling Curate and configure POS integration.
- [Clienteling](https://docs.omneo.io/experiences/clienteling/overview.md): The staff-facing in-store surface for personalised customer service and real-time profile access.
- [CX Manager changelog](https://docs.omneo.io/experiences/cx-manager/changelog.md): Release history and upcoming changes for CX Manager.
- [CX Manager](https://docs.omneo.io/experiences/cx-manager/overview.md): The Omneo administration interface for configuring incentives, managing profiles, and running operations.
- [Omneo Insights](https://docs.omneo.io/experiences/omneo-insights/overview.md): Reporting and analytics for your Omneo customer data.
- [Profile Portal changelog](https://docs.omneo.io/experiences/profile-portal/changelog.md): Release history and upcoming changes for Profile Portal.
- [Configuring Profile Portal](https://docs.omneo.io/experiences/profile-portal/configuration.md): How to set up and configure Profile Portal for your brand.
- [Profile Portal](https://docs.omneo.io/experiences/profile-portal/overview.md): The customer-facing self-service web app for profile management, incentive display, and transaction history.
- [Adobe Commerce changelog](https://docs.omneo.io/extensions/adobe-commerce/changelog.md): Release history and upcoming changes for the Omneo Adobe Commerce extension.
- [Adobe Commerce](https://docs.omneo.io/extensions/adobe-commerce/overview.md): The Omneo Adobe Commerce (Magento 2) extension connects your store to Omneo for profile sync, transaction recording, and reward redemption at checkout.
- [Apparel21](https://docs.omneo.io/extensions/apparel21/overview.md): The Omneo Apparel21 integration connects Omneo to Apparel21 ERP and POS for profile sync and transaction recording.
- [Attentive](https://docs.omneo.io/extensions/attentive/overview.md): The Omneo Attentive integration connects Omneo loyalty events to Attentive for SMS marketing.
- [BigCommerce changelog](https://docs.omneo.io/extensions/bigcommerce/changelog.md): Release history and upcoming changes for the Omneo BigCommerce extension.
- [BigCommerce](https://docs.omneo.io/extensions/bigcommerce/overview.md): The Omneo BigCommerce extension connects BigCommerce to Omneo for profile sync, transaction recording, and reward redemption.
- [Cin7](https://docs.omneo.io/extensions/cin7/overview.md): The Omneo Cin7 integration connects Omneo to Cin7 for inventory-aware profile sync and transaction recording.
- [Commerce Layer changelog](https://docs.omneo.io/extensions/commerce-layer/changelog.md): Release history and upcoming changes for the Omneo Commerce Layer integration.
- [Commerce Layer](https://docs.omneo.io/extensions/commerce-layer/overview.md): The Omneo Commerce Layer integration connects Commerce Layer to Omneo for profile sync, order-to-transaction recording, and incentive management in headless commerce implementations.
- [commercetools changelog](https://docs.omneo.io/extensions/commercetools/changelog.md): Release history and upcoming changes for the Omneo commercetools extension.
- [commercetools](https://docs.omneo.io/extensions/commercetools/overview.md): The Omneo commercetools extension connects commercetools to Omneo for profile sync, order-to-transaction recording, and incentive management.
- [Emarsys](https://docs.omneo.io/extensions/emarsys/overview.md): The Omneo Emarsys integration connects Omneo customer and loyalty data to Emarsys for omnichannel marketing automation.
- [Gorgias changelog](https://docs.omneo.io/extensions/gorgias/changelog.md): Release history and upcoming changes for the Omneo Gorgias integration.
- [Gorgias](https://docs.omneo.io/extensions/gorgias/overview.md): The Omneo Gorgias integration surfaces customer profile data in Gorgias ticket sidebars and syncs customer data between platforms.
- [Setting up the Gorgias integration](https://docs.omneo.io/extensions/gorgias/setup.md): How to install and configure the Omneo Gorgias integration.
- [Indigo 8](https://docs.omneo.io/extensions/indigo8/overview.md): The Omneo Indigo 8 integration connects Omneo to the Indigo 8 retail management system for profile sync and transaction recording.
- [Klaviyo](https://docs.omneo.io/extensions/klaviyo/overview.md): The Omneo Klaviyo integration connects Omneo customer data and loyalty events to Klaviyo for email and SMS marketing automation.
- [Extensions overview](https://docs.omneo.io/extensions/overview.md): How Omneo connects to the platforms your brand already uses.
- [Salesforce Commerce Cloud changelog](https://docs.omneo.io/extensions/salesforce-cc/changelog.md): Release history and upcoming changes for the Omneo Salesforce Commerce Cloud extension.
- [Salesforce Commerce Cloud](https://docs.omneo.io/extensions/salesforce-cc/overview.md): The Omneo Salesforce Commerce Cloud extension syncs profiles, orders, and transactions and enables reward redemption at checkout.
- [Salesforce Marketing Cloud](https://docs.omneo.io/extensions/salesforce-mc/overview.md): The Omneo Salesforce Marketing Cloud integration connects Omneo loyalty data to SFMC for personalised marketing journeys.
- [Shopify changelog](https://docs.omneo.io/extensions/shopify/changelog.md): Release history and upcoming changes for the Omneo Shopify extension.
- [Checkout rewards](https://docs.omneo.io/extensions/shopify/checkout-rewards.md): Integrating Omneo reward redemption into Shopify checkout.
- [Shopify](https://docs.omneo.io/extensions/shopify/overview.md): The Omneo Shopify extension connects your Shopify store to Omneo, syncing profiles, orders, products, and transactions bidirectionally.
- [Setting up the Shopify extension](https://docs.omneo.io/extensions/shopify/setup.md): How to configure the Omneo Shopify extension for profile sync, order sync, and product sync.
- [Zendesk changelog](https://docs.omneo.io/extensions/zendesk/changelog.md): Release history and upcoming changes for the Omneo Zendesk plugin.
- [Zendesk](https://docs.omneo.io/extensions/zendesk/overview.md): The Omneo Zendesk plugin displays customer data in Zendesk tickets and syncs profile interactions between platforms.
- [Setting up the Zendesk plugin](https://docs.omneo.io/extensions/zendesk/setup.md): How to install and configure the Omneo Zendesk plugin.
- [Accessing CX Manager](https://docs.omneo.io/getting-started/accessing-cx-manager.md): How to log in to Omneo CX Manager and find your tenant URL.
- [CX Manager Tour](https://docs.omneo.io/getting-started/cx-manager-tour.md): A guided walkthrough of each section of the Omneo CX Manager.
- [Extensions Overview](https://docs.omneo.io/getting-started/extensions-overview.md): How Omneo connects to your eCommerce, POS, comms, and analytics platforms.
- [Omneo Insights](https://docs.omneo.io/getting-started/omneo-insights.md): Understanding the reporting and analytics capabilities available in Omneo.
- [What is Omneo?](https://docs.omneo.io/getting-started/what-is-omneo.md): An introduction to Omneo — a retail CX platform built around the known customer.

## OpenAPI Specs

- [api](https://docs.omneo.io/api-reference/api.json)

## Optional

- [Website](https://omneo.io)