API integration

EngageOne Communicate offers a REST API that gives programmatic access to the actions available in the Communicate web application, such as blacklisting email addresses, adding assets to the Asset Library, creating campaigns.

This is a headless API. Refer to the Swagger documentation for the environment (server) URLs.

The following APIs are available:

Type Description Swagger documentation
Public API Endpoints for actions that do not require authentication, such as adding an email address to the unsubscribe list. http://pbpx-swagger.s3-website-us-east-1.amazonaws.com/public.html
Private API Endpoints for actions that require authentication because they access the company's campaigns, communications, templates and assets. http://pbpx-swagger.s3-website-us-east-1.amazonaws.com/private.html
User Services API Endpoints for login and authentication. http://pbpx-swagger.s3-website-us-east-1.amazonaws.com/users.html

To use the APIs, you need to:

  1. Get the client credentials for your company account.
  2. Get an authentication token (S3 key) using the User Services API /authenticate endpoint.
  3. Invoke the Private API with your authentication headers.

Get client credentials

In order to invoke the endpoints in the Private API, you require a set of client credentials. You can obtain this from the Company Management page of the web platform. You need to be an administrator to access this page. Each company has a single set of client credentials.

  1. Log into Communicate at https://communicate.ces.pitneycloud.com/.
  2. If you have access to more than one company account, select the company by clicking your name in the header.
  3. Click to go to the Company Management page.
  4. Under Client Credentials, click + Create client credentials.
  5. Hover over the CustomerID, ClientID and Secret to copy these to the clipboard.
  6. In particular, keep the secret for use later — the secret is only shown once (the customer ID and client ID won’t change). If you lose the secret, you will need to generate a new one.
Note: If client credentials already exist and you don't know the secret, click Regenerate Secret to get a new secret. You will then need to update any existing integration that uses the secret.

Get authentication token

In order to call the endpoints in the Private API, you need to provide two authentication headers:

Header Details
PB-Customer-Id ID of the Communicate company you are acting on. This is the name of the company prefixed with eocm-, and with spaces replaced by hyphens. This is case sensitive.
Authorization Takes the form of Bearer {token} where {token} is a JWT token (S3 key) obtained with the client credentials calling the /authenticate endpoint in the User Services API.

Remove API access

Delete the client credentials to disable API access to the company account.