Channel consent API

Overview

Get the consent value for a given database, channel, qualifier, lookup key, and destination. This could also include the external UID such as customerid or loyaltyid if there are web forms that customers could fill out and have a contact added to Acoustic Campaign with this information.

Functionalities available

The Channel Consent API call has GET functionalities.

GET: This call return contacts that match based on the lookup key.

GET /databases/{databaseId}/consent/{channel}-{qualifier}/{lookupKey}/{destination}
(e.g. /databases/746583/consent/PUSH-appKey1000/15063434671/MUID1234|XCID4321)

Scenarios that can be accomplished using this API

An external system calls the API to determine the consent status for the contact.

Request Body Model

ConsentData

Attribute

Required

Description

Data type

Status

Yes

Opt in status. Acceptable values are ‘OPT-IN’ and ‘OPTED-OUT’

String

consentDate

Optional

Optional timestamp represented in a String

Date

consentSource

Optional

The source

String

Response Content Type

application/json

Parameter

Value

Description

Parameter type

Data type

database Id

required

Database ID for PUSH app.

path

Long

channel

required

Channel for PUSH

path

String

qualifier

required

AppKey for PUSH

path

String

lookupKey

required

Lookup key (mobile user ID) for this contact

path

String

destination

required

Destination for this contact (Xtify user ID and channel ID).

path

String

Model Schema reference

{
"status": "String",
"consentDate": "Date",
"consentSource": "String"
}

Sample JSON Request Body

{

"status":"OPTED-IN",
"consentDate":"2015-05-01T23:01:12.000Z"
}

Swagger URL

https://api-campaign-[data center]-[pod#].goacoustic.com/restdoc/#!/databases/consent_put_put_9

For example, here's the Swagger URL for data centers in the US on pod 0:
https://api-campaign-us-0.goacoustic.com/restdoc/#!/databases/consent_put_put_9