Skill Level: Any
The Delete Table API supports programmatically deleting Relational Table data from¬†Acoustic Campaign.
You cannot delete the Relational Table in any of the following cases:
- The table is in use by active Group of Automated Messages.
- The table is in use by an active Autoresponder.
- The table is in use by an active Sending mailing.
- When queries exist that reference the table, but are owned by an associated database.
The following can be deleted:
- Table data
- The table entity/structure
- Database/Table associations (joins)
- Relational Table queries
Syntax of the request and response XML for DeleteTable
Operation <DeleteTable> Elements TABLE_NAME Optional parameter to specify the folder path and name of the Relational Table you are deleting. Either TABLE_NAME or TABLE_ID is required.¬†Note: If you specify TABLE_VISIBILITY,¬†Acoustic Campaign ignores Private/Shared in TABLE_NAME. ¬† TABLE_ID Optional parameter that specifies the ID of the Relational Table you are deleting. Either TABLE_NAME or TABLE_ID is required.Note: The Acoustic Campaign does not specify Private/Shared as part of the path. ¬† TABLE_VISIBILITY Optional field that defines the visibility of the table you are referencing. Required if not specified in TABLE_NAME. 0 – Private 1 – Shared ¬† Optional If specified, the Acoustic Campaign sends notification to the provided email address when the job is complete. Example
<Envelope> <Body> <DeleteTable> <TABLE_NAME>WebAnalyticsPurchases</TABLE_NAME> <TABLE_VISIBILITY>0</TABLE_VISIBILITY> <EMAIL>firstname.lastname@example.org</EMAIL> </DeleteTable> </Body> </Envelope>
Response <RESULT> Elements SUCCESS True if successful. ¬† JOB_ID Identifies the Acoustic Campaign¬†background job that is created and scheduled for this table deletion. Example
<Envelope> <Body> <RESULT> <SUCCESS>TRUE</SUCCESS> <JOB_ID>499600</JOB_ID> </RESULT> </Body> </Envelope>