Jump to Content
Campaign
DocumentationRecipesAPI referenceHome
Help CenterCommunityDevelopersAcademyStatusLog InCampaign
API reference
Help CenterCommunityDevelopersAcademyStatusLog In
DocumentationRecipesAPI referenceHome

Campaign APIs

  • Overview
    • API developer's guide and legal information
    • API limits
    • Getting started with OAuth
    • OAuth token creation
    • Legacy authentication method: JSESSIONID user sessions
  • Compare bulk event export and raw recipient data export

Campaign REST APIs

  • REST API overview
  • Response codes
  • GET contact by lookup key
  • Get rich content
  • Create rich content
  • Get published messages
  • In-App content API
  • Creating simple vs rich mobile app push messages
  • Push to segment
  • Push to segment API with inline content
  • BCC REST API
  • Add a column to an existing relational table
  • Map universal behaviors
  • Delete list REST API
  • SMS external consent API
  • Export SMS messages
  • Send SMS to contact source
  • Send transactional SMS messages
  • Check status of SMS sent
  • Channel consent API
  • Contact by channel
  • Establish identity
  • Push to Contact API
  • Push to device
  • DLL whitelist APIs
    • Get a collection of DLL whitelist domains
    • Add a new domain to DLL whitelist
    • Remove an existing domain from DLL whitelist
  • Send a MO message

Campaign XML APIs

  • XML API overview
  • Code samples and responses
  • FAQs
  • Test harness
  • Optimove – Acoustic Campaign API integration
  • Postman collection
  • Error codes
  • Automation
    • Get a contact’s relationship to programs - GetProgramsByContact
    • Get a list of programs - GetPrograms
  • Database management
    • Add a contact - AddRecipient
    • Calculate current query contacts - CalculateQuery
    • Create a database query - CreateQuery or Classic Query
    • Double opt-in a contact - DoubleOptInRecipient
    • Export from a database - ExportList
    • Get a list of databases - GetLists
    • Get database details - GetListMetaData
    • Import to a database - ImportList
    • Retrieve contact information - SelectRecipientData
    • Remove a contact - RemoveRecipient
    • Update a column value - SetColumnValue
    • Update a contact - UpdateRecipient
    • Opt-out a contact - OptOutRecipient
    • Purge data - PurgeData
  • Contact list management
    • Add a contact to a contact list - AddContactToContactList
    • Create a contact list - CreateContactList
    • Add a contact to a program - AddContactToProgram
    • Get a contact's mailing details - GetContactMailingDetails
  • Relational table management
    • Create a relational table - CreateTable
    • Import a relational table from an FTP server - ImportTable
    • Export relational table data - ExportTable
    • Delete relational table data - PurgeTable
    • Associate relational data with contacts in a database - JoinTable
    • Add or update relational table data - InsertUpdateRelationalTable
    • Delete records from a relational table - DeleteRelationalTableData
    • Delete a relational table - DeleteTable
  • Scoring models
    • Get a contact's scoring model scores - GetContactScores
    • Get an organization's scoring models - GetScoringModels
  • Template and mailing management
    • Get a list of mailing templates - GetMailingTemplates
    • Schedule a mailing - ScheduleMailing
    • Send an email to a contact - SendMailing
    • Forward a mailing to another contact - ForwardToFriend
    • Preview a mailing before sending - PreviewMailing
    • Export a mailing template - ExportMailingTemplate
    • Create or update a mailing template - SaveMailing
    • Get details about an automated message group - GetMessageGroupDetails
  • Dynamic content
    • Create a ruleset - AddDCRuleset
    • Delete a ruleset from the asset library - DeleteDCRuleset
    • Export a ruleset and associated content - ExportDCRuleset
    • Get details of a dynamic content ruleset - GetDCRuleset
    • Import a dynamic content ruleset - ImportDCRuleset
    • Get a list of rulesets for an email - ListDCRulesetsForMailing
    • Update an existing ruleset - ReplaceDCRuleset
    • Validation check of rulesets - ValidateDCRuleset
  • Reporting
    • Get a contact email list - ListRecipientMailings
    • Extract report IDs for an email - GetReportIdByDate
    • Get a list of emails sent for an organization - GetSentMailingsForOrg
    • Get a list of sent emails for a user - GetSentMailingsForUser
    • Get a list of sent emails for an organization - GetSentMailingsForList
    • Get user aggregate tracking metrics - GetAggregateTrackingForUser
    • Get organization aggregate tracking metrics - GetAggregateTrackingForOrg
    • Export raw contact events - RawRecipientDataExport
    • Export web tracking events - WebTrackingDataExport
    • Get email aggregate tracking metrics - GetAggregateTrackingForMailing
  • Miscellaneous
    • Delete a data job - DeleteJob
    • Get the path of a folder or object - GetFolderPath
    • Get the status of a data job - GetJobStatus

Automation

Updated 4 months ago


Error codes
Get a contact’s relationship to programs - GetProgramsByContact
Did this page help you?

Updated 4 months ago


Error codes
Get a contact’s relationship to programs - GetProgramsByContact
Did this page help you?
community icon

Join the community

Ask questions, share best practices, and connect with fellow marketers.

Ask a question
academy icon

Academy

Read how-to articles, guides, and more to help you on the path to success.

Learn more
Acoustic logo

What do you want to achieve?

Contact us and we’ll help you get there.

Acoustic Twitter
Acoustic Youtube
Acoustic Linkedin

Products

  • Acoustic Connect
  • Tealeaf by Acoustic
  • DemandTec by Acoustic
  • Acoustic Campaign

Customers

  • Support
  • Help Center
  • Community
  • Acoustic Academy
  • Developers

About acoustic

  • About us
  • Careers
  • Company News
  • Partner with us
  • Resources

© Copyright 2024 Acoustic, L.P. All Rights Reserved.

  • Privacy
  • Terms & Conditions
  • Accessibility