Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The ECM REST APIs allow configuring resources such as campaigns, strategies, and campaign contacts. It currently supports the following functions:

...

Protocol

HTTP or HTTPS

URL

https://<UMM-FQDN>/umm/ecm/campaign/delete?id=1

AuthorizationBearer token-from-login-API

Content-Type

Application/JSON

HTTP Method

DELETE

Input/Output Format

JSON

Request Parameters

  • id: ECM campaign ID OR
  • crmCampaignId: CRM campaign ID associated with the ECM campaign

HTTP Request


HTTP Response

200: Success

404: Not found

500: Internal Server Error

503: Service Unavailable

Example Response


...

Protocol

HTTP or HTTPS

URL

https://<UMM-FQDN>/umm/ecm/contact/uploadCsv

AuthorizationBearer token-from-login-API

Content-Type

Application/JSON

HTTP Method

POST

Input/Output Format

JSON

Request Body

File: A CSV file as an attachment, multipart file

The File format should be the following:

contact-number,optional-name

HTTP Request


HTTP Response

200: Success

404: Not found

500: Internal Server Error

503: Service Unavailable

Example Response


Upload Contacts

...

to Campaign

This API is used to push contacts to an ECM campaign for making calls or sending messages.

...