Get consents (version 2) (beta)

Beta

This is a new feature in APSIS One API and we are still keeping a close look on performance and potential issues. Please report any feedback to [email protected].

Consent 2.0

This feature is a part of Consent 2.0 functionality in APSIS One.

See this page to understand how to proceed with your existing and new integrations.

About consent

If a profile wants to receive communication regarding a specific topic over a specific channel (email or SMS), they must first give consent. The consent information is saved in APSIS One on a profile level along with the topic and the channel the consent is given for.

The following consent types are supported by APSIS One:

  • opt-in - profile permits communication
  • opt-out - profile forbids any communication
  • pending-opt-in - communication permission waits for the profile to confirm it (not supported by APSIS One API yet)
  • confirmed-opt-in - profile permits communication which they also confirmed (not supported by APSIS One API yet)

Confirming the consent, also known as double opt-in, is usually done via a link in an email that is sent to the profile.

Get consents

Get all or selected types of consents for different topics over various channels currently existing for a specific profile.

Profile is identified by keyspace discriminator and profile key. Topic is identified by section discriminator and topic discriminator.

The source, reason and modified_at properties are not provided in Consent 1.0 but will always be returned in Consent 2.0.

Suppression

Suppression is the APSIS One feature that allows users to block any communication to a specific address. It takes priority over any profile consents. Useful when one of your customers calls you and requests to halt all communication.

As a result, for a profile to receive any marketing communication from the APSIS One platform, two conditions must be met:

  • an opt-in or confirmed opt-in consent for a specific topic over a specific channel must exist on the profile
  • the address must not be suppressed

Note that consent is given on the profile level whereas suppression works on the address level.

This APSIS One API endpoint provides information about the existing suppression, if any. Existing suppression for the address that is used as profile_key is always returned. If you need to check if any suppression exists for another address, use suppression_channel_discriminator and suppression_address query string parameters.

In the example response, despite being subscribed to a topic over two channels, the profile will only receive email communication since the address on the SMS channel is suppressed.

Language
Authentication
Bearer
JWT
URL