POST /companies/{companyId}/campaignManagement/{donationCampaignId}/status/{status}

Starts or stops the donation campaign specified in the path, by providing a path parameter. Use the path parameter activate to start an inactive campaign, or end to stop an active campaign. Other status transitions are not allowed.

To make this request, your API credential must have the following role:

Servers

Path parameters

Name Type Required Description
companyId String Yes

The unique identifier of the company account.

donationCampaignId String Yes

The unique identifier of the donation campaign to activate or end.

status String Yes

The desired status change. Possible values: activate or end.

Valid values:

  • "activate"
  • "end"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.