Send data to Cordial

Cordial is a cross-channel marketing and data platform that collects all of your customer data in one platform for use with audience segments, trends, and automated customer experiences.

Use Amperity to manage contacts–attributes and list membership–in Cordial using the following REST APIs:

  • Account Contract Attributes to create contact attributes. Attributes that do not exist in Cordial are added as custom contact attributes.

  • Account Lists to fetch, create, and clear account lists, to which contacts are associated. An account list is overwritten each time results are sent from Amperity. An email address is added when it is not already a contact, after which it is assigned the subscribed status. An email address that is already a contact will retain its assigned subscription status.

  • Contact Imports to import contacts to Cordial, and then associate contacts to the account list.

  • Jobs to monitor the import job for completion.

Build a query or segment that contains the email field, along with any other fields that you want created or updated in Cordial and represented as contact attributes.

This topic describes the steps that are required to send audience lists to Cordial from Amperity:

  1. Get details

  2. Add destination

  3. Add data template

Get details

Cordial requires the following configuration details:

  1. A Cordial API key.

    Important

    Use the IP address for Amperity to configure the allowlist for the Cordial API.

  2. The name of the contacts list.

    Important

    The list name is configured as part of the data template.

  3. The following REST API methods must be enabled:

    GET /accountcontractattributes
    POST /accountcontractattributes
    
    GET /accountlists
    POST /accountlists
    PUT /accountlists/{key}/clear
    
    POST /contactimports
    
    GET /jobs/{id}
    
  4. A query or segment that returns the email field, along with any other fields that you want created or updated in Cordial and represented as contact attributes in Cordial.

Add destination

Configure Amperity to send data to Cordial using the Cordial API.

To add a destination

  1. From the Destinations tab, click Add Destination. This opens the Add Destination dialog box.

  2. Enter the name of the destination and a description. For example: “Cordial” and “This sends audience lists to Cordial”.

  3. From the Plugin drop-down, select Cordial.

  4. The “cordial” credential type is selected automatically.

  5. From the Credential drop-down, select Create a new credential. This opens the Create New Credential dialog box.

  6. Enter a name for the credential along with the Cordial API key. Click Save.

  7. Select Allow customers to use this destination.

  8. Select Allow orchestrations from users with limited PII access. (A user with limited PII access has been assigned the Restrict PII Access policy option.)

  9. Click Save.

Add data template

A data template defines how columns in Amperity data structures are sent to downstream workflows. A data template is part of the configuration for sending query and segment results from Amperity to an external location.

You have two options for setting up data templates for Cordial:

  1. For use with campaigns

  2. For use with orchestrations

for campaigns

You can configure Amperity to send campaigns to Cordial. These results are sent from the Campaigns tab. Results default to a list of email addresses, but you may configure a campaign to send additional attributes to Cordial.

To add a data template for campaigns

  1. From the Destinations tab, open the menu for a destination that is configured for Cordial, and then select Add data template.

    This opens the Add Data Template dialog box.

  2. Enter the name of the data template and a description. For example: “Cordial audiences” and “Send audiences to Cordial.”

  3. Enable the Allow customers to use this data template option, and then enable the Make available to campaigns option. This allows users to send campaign results from Amperity to Cordial.

  4. Verify all template settings and make any required updates.

  5. Click Save.

for orchestrations

You can configure Amperity to send query results to Cordial. These results are sent using an orchestration.

To add a data template for orchestrations

  1. From the Destinations tab, open the menu for a destination that is configured for Cordial, and then select Add data template.

    This opens the Add Data Template dialog box.

  2. Enter the name of the data template and a description. For example: “Cordial customer profiles” and “Send email addresses and customer profiles to Cordial.”

  3. Under Webhook settings, add the Label Name. For example: “Cordial”. The Webhook Settings should be set to empty curly braces: {}.

  4. Enable the Allow customers to use this data template option. This allows users to build queries, and then configure orchestrations that send results from Amperity to a configured destination.

  5. Optional. Enable the Allow orchestrations from customers with limited PII access option. This allows users who have been assigned the Restrict PII Access policy option to send results from Amperity.

  6. Verify all template settings and make any required updates.

  7. Click Save.