API reference
Help CenterCommunityDevelopersAcademyStatus

Associate relational data with contacts in a database - JoinTable

Associates an Acoustic Campaign database with an Acoustic Campaign relational table.

📘

Notes

You must specify a table (name or ID) and database/list (name or ID) along with the contact columns that make the association.

Only one of the elements TABLE_NAME or TABLE_ID are required, not both.

Only one of the elements LIST_NAME or LIST_ID are required, not both.

Elements (Required)

TABLE_NAME - Specifies the folder path and name of the relational table to associate with the specified database. If you specify TABLE_VISIBILITY, Acoustic Campaign ignores Private/Shared in TABLE_NAME.

TABLE_ID - Specifies the ID of the relational table to associate with the specified database. Acoustic Campaign does not specify Private/Shared as part of the path.

TABLE_VISIBILITY - Only required if not specified in TABLE_NAME. Defines the visibility of the table you are referencing: 0 (private) or 1 (shared).

LIST_NAME - Specifies the folder path and name of the database to associate with the specified table. If you specify LIST_VISIBILITY, Acoustic Campaign ignores Private/Shared in LIST_NAME.

LIST_ID - Specifies the ID of the database to associate with the specified table.

LIST_VISIBILITY - Only required if not specified in LIST_NAME. Defines the visibility of the database you are referencing: 0 (private) or 1 (shared).

Elements (Optional)

REMOVE - Boolean element that is used to remove the relationship between a database and a relational table. If specified, Acoustic Campaign ignores any MAP_FIELD elements.

EMAIL - If specified, Acoustic Campaign sends a completion notification to the provided email address.

MAP_FIELD - XML node that contains the elements LIST_FIELD and TABLE_FIELD.
LIST_FIELD - A child of MAP_FIELD. Contains the field name in the Acoustic Campaign
database.
TABLE_FIELD - A child of MAP_FIELD. Contains the field name in the relational table.

<Envelope>
  <Body>
    <JoinTable>
      <TABLE_NAME>Shared/WebAnalytics/Purchases</TABLE_NAME>
      <LIST_ID>65745</LIST_ID>
      <MAP_FIELD>
        <LIST_FIELD>ItemID</LIST_FIELD>
        <TABLE_FIELD>ItemID</TABLE_FIELD>
      </MAP_FIELD>
      <MAP_FIELD>
        <LIST_FIELD>PurchPrice</LIST_FIELD>
        <TABLE_FIELD>Purchase Price</TABLE_FIELD>
      </MAP_FIELD>
    </JoinTable>
  </Body>
</Envelope>

<Envelope>
  <Body>
    <RESULT>
      <SUCCESS>TRUE</SUCCESS>
      <JOB_ID>108518</JOB_ID>
    </RESULT>
  </Body>
</Envelope>

Elements (Results)

SUCCESS - True if successful

JOB_ID - Identifies the Acoustic Campaign background job created and scheduled for this process.