API credentials

To use the API functionality in Campaign Studio, you must enable API credentials and then configure API settings. These configurations are located in two different parts of the UI in Settings.

Enabling API credentials

To enable API credentials:

  1. Log in to Campaign Studio.
  2. Click the Settings icon.
  3. Click API Credentials.
  4. On the API Credentials page, in the drop-down list, select OAuth 2.


EOL notice! To facilitate the upgrade to Symfony v4.4, OAuth1 reached EOL in favor of OAuth2 for all Acquia Campaign Studio customers on April 4, 2022. This upgrade allows existing APIs to continue functioning and provides a more seamless user experience as Acquia continues to make improvements to Acquia Campaign Studio.

To continue to utilize and access APIs, Acquia Campaign Studio customers must upgrade it before the April 4, 2022 deadline.

Obtaining a new access token

  1. Make a POST to the access token’s endpoint oauth/v2/token using the client_credentials grant type:

    POST /oauth/v2/token

    The response returned should be a JSON encoded string:

         access_token: "NEW_ACCESS_TOKEN",
         expires_in: 3600,
         token_type: "bearer",
         scope: ""

API settings

To configure API settings, follow the instructions provided in the API settings section in Configuration.

For more API Campaign Studio documentation, see: