Please wait

Loading...

To use the API functionality in Campaign Studio, do the following:

  1. In Settings > Configuration >  API Settings, verify the API settings.
  2. In Settings > API Credentials, configure the API credentials.

Configuring the API credentials

To configure the API credentials:

  1. Log in to Campaign Studio.
  2. Click the Settings icon.
  3. Click API Credentials.
  4. Click New.
  5. On the Credentials - New Credential page, in the drop-down list, select OAuth 2.
  6. In Name, enter a name for the API credential.
  7. In Redirect URI, enter one or more URIs that have API access.
  8. Click Save & Close.

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
    
    client_id=CLIENT_ID
    
        &client_secret=CLIENT_SECRET
    
        &grant_type=client_credentials

    The response returned should be a JSON encoded string:

    {
    
         access_token: "NEW_ACCESS_TOKEN",
    
         expires_in: 3600,
    
         token_type: "bearer",
    
         scope: ""
    
     }
Note

Campaign Studio uses PHP native local codes. If you make changes to the preferred_locale field for contacts through the API, see the PHP: Local Manual. For a list of countries codes, see this Letter codes of cultures (languages, countries/regions) list and replace the hyphen with an underscore in Campaign Studio.

For more Campaign Studio API documentation, see: