V5 API Endpoint (Authenticated) Integration

Last Updated: 17/4/2024     Tags: V5 API Endpoint (Authenticated), Integrations, V5 API, Endpoint, Authenticated
  • Switch Version
  • V5
  • V4

Integrations is not available for Taguchi V4 and is only available in V5.
Please contact Support if you don't know which version of Taguchi you are using.

Taguchi has an API integration which creates a seamless and automated connection between your email marketing database in Taguchi, and your organisation.

This integration means you don't need to manually handle your subscriber data externally between Taguchi and your organisation to achieve the above, reducing the risk of data security issues and not to mention effort.

V5 API Endpoint (Authenticated) Integration

Our simple, self-serve integration tool offers a smart and secure way to manage your integration; without the risk and inefficiencies of manually handling customer data.

Credentials

You will need to setup up one credential before you are able to create an V5 API Endpoint (Authenticated) integration. The main credential that you would need to set up will be the API token. Here is more information on setting up the API Token credential.

Create Your V5 API Endpoint(Authenticated) Integration

New Integration

To create a new integration, ensure that you have the required User Type integration role privileges assigned to you. The 'integration' page is under Settings > Integrations.

Create New List

Select ‘New Integration’ and a new screen will popup.

Create New List

Details

Create New List

  1. Set the name of the integration. Under 'Type', select 'V5 API Endpoint (Authenticated)'.

  2. The API endpoint URL is accessed using HTTP requests, and each endpoint has a unique URL. When you create a new endpoint API integration, it will create a new unique endpoint URL for you. You will be able to access the "Test OpenAPI Spec File" and "Production OpenAPI Spec File" after your integration has been created.

Configuration

Create New List

  1. Credential to use: Choose the desired credential to use that you have set up in the credential page.

  2. Identify profiles by: You can identify profiles by using External (ID), Email or by phone number.

  3. Allow subscriber profile retrieval/creation/updates/anonymization and event logging: Click on the checkboxes if you want to allow subscriber profile retrieval, profile creation, profile updates, profile anonymization and event logging.

  4. Allow messages to be sent: This will allow users to receive eDMs that you have specified within the "Trigger activity ID".

  5. Field validation rules (JSON object): This refers to a set of rules defined in a JSON object format that specifies how the fields of a request payload should be validated.

  6. Trigger activity ID (blank to allow any): The trigger activity ID will trigger an activity within the Taguchi platform based on your input. Leaving it blank will disable this feature.

  7. Allow messages to be sent to unsubscribed users: This feature allows you to send out eDMs (order confirmation) to users that are unsubscribed. The "Trigger activity ID" will determine the eDM that users will receive.

  8. Add subscriber profiles to main list: You can manage which main list that subscribers can be added to when they are added in through this integration.

  9. Mode for unsubscribes: You can choose two different modes ot unsubscribe users, they are Global and Main list.

  10. Custom field to unsubscribe subscribers (Must be part of api request): This feature allows you to choose a custom field value that will trigger an subsubcribe.

  11. Operator to use with custom field and unsub value for unsubscribes: You have the option of choosing "Not Equal to" (=!) or "Equal To" (==) operators to use with custom field and unsub value for unsubscribes.

  12. Unsubscribe value to compare with custom field for unsubscribes: Add an unsubscribe value into the input to compare with custom field for unsubscribes.

  13. Import source name: This is a parameter or field in the payload of a request that indicates the source of the data being imported.

  14. Request deduplication period (sec): This mechanism is used to prevent duplicate requests from being processed within a certain time window. The time window is determined by your input (sec).

  15. Always return 200 even if errors occur (webhook mode): By activating this checkbox, this API endpoint integration will be configured to always return a 200 status code even if errors occur.

  16. Add subscriber profiles to other lists: Input a list ID into this field to add subscribers to anothe list.

  17. Identify partitions by: You can identify partitions either by External ID(ref) or Taguchi ID.

  18. Allow parition retrieval/creation/updates: You can allow partision retrieval, creation and/or updates by clicking on their respective checkbox to activate them.

Save Changes and Activate

Create New List

Once you have added your Details, Configuration and Target Expression, you will be able to save changes (1) and activate (2) the integration. You can only activate once you have save changes.

Deactivate

Create New List

To stop the integration, click on Deactivate. This will stop Taguchi and TikTok from sharing data.

Active Integration

Create New List

Once the integration has been saved and activated, the on/off icon of the integration card will change from yellow (Off) to green (On) which indicates that it is now activated.

Update Integration

Create New List Create New List

If you want to update your Integration, you will be able to make the changes while it is activated or deactivated. Once the changes have been made, you will be able to update the integration by clicking on 'Save changes'. The Integration will be updated immediately.

If you are having trouble with this integration, please contact Taguchi Support for assistance.