How to Specify Channel Consent in a Subscribed Profile

Once a Profile has been subscribed to a Topic in a Consent list, the next step is to specify the Profile's type and level of consent.

Need a refresher?

Jump here to read about the levels of consent, or here to read more about the types of consent.

To specify the consent of a Profile, we'll need the following.

  • Valid Section from the APSIS One account

  • Valid Consent list from the Section

  • Valid Topic from the Consent list

  • Valid Channel

  • The email address or mobile number

  • Type of Consent

Let's go!

We'll use the same example Section, Consent List and Topic we used for how to subscribe a Profile to a Topic.

To begin, fetch the Channels from the APSIS One account:

Per region host names

APSIS One API is provided under different host names depending on your region. For EU use https://api.apsis.one/, for APAC call https://api-apac.apsis.one/.

curl --request GET \
  --url https://api.apsis.one/audience/channels \
  --header 'authorization: Bearer '

This will return the following JSON object.

{
  "items": [
    {
      "discriminator": "com.apsis1.channels.email",
      "name": "Email",
      "description": "Email Channel"
    },
    {
      "discriminator": "com.apsis1.channels.sms",
      "name": "SMS",
      "description": "SMS Channel"
    },
    {
      "discriminator": "com.apsis1.channels.web",
      "name": "Web",
      "description": "Web Channel"
    }
  ]
}

Let's review what we need to successfully subscribe a Profile with Consent for email channel.

  • Section: usercreated.sections.se-data-n9smkyebwq

  • Consent list: usercreated.targets.all_profiles-w6k6v1vnxu

  • Topic: usercreated.topics.jeans-zz8xl5pcnp

  • Type of Consent: Opt-in

  • Channel: com.apsis1.channels.email

  • Address: andy@apsis.com

Let's review what we need to successfully subscribe a Profile with Consent for sms channel:

  • Section: usercreated.sections.se-data-n9smkyebwq

  • Consent list: usercreated.targets.all_profiles-w6k6v1vnxu

  • Topic: usercreated.topics.jeans-zz8xl5pcnp

  • Type of Consent: Opt-in

  • Channel: com.apsis1.channels.sms

  • Address: MSISDN format, for example: 46793699558

Next, determine the level of consent for the Topic by specifying the Channel and level of Consent.

A successful call will return a HTTP 204 No Content status code.

curl --request POST \
  --url https://api.apsis.one/audience/channels/com.apsis1.channels.email/addresses/andy@apsis.com/consents \
  --header 'authorization: Bearer ' \
  --data '{
    "section_discriminator": "usercreated.sections.se-data-n9smkyebwq",
    "consent_list_discriminator": "usercreated.targets.all_profiles-w6k6v1vnxu",
    "topic_discriminator": "usercreated.topics.jeans-zz8xl5pcnp","type":"opt-in"
}'

Good to know...

Once you have added a Subscription to a Profile and Consent has been created, it can take up to 15 minutes before that Profile is visible in the APSIS One UI.

Did this answer your question?