ADadyen
Donation campaigns

Activate or end a donation campaign

Changed on

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:

  • Management API—Campaign Management read and write
post/companies/{companyId}/campaignManagement/{donationCampaignId}/status/{status}

Request

  • Base URL
    https://management-test.adyen.com/v3
  • URL
    https://management-test.adyen.com/v3/companies/{companyId}/campaignManagement/{donationCampaignId}/status/{status}
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Path parameters

companyIdstring required

The unique identifier of the company account.

donationCampaignIdstring required

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

status'activate' | 'end' required

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

Response

OK - the request has succeeded.

accountHolderIdsstring[]

The unique identifiers of the account holders associated with the donation campaign.

activatedAtstring date-time

The date and time when the campaign started, in ISO 8601 format. For example, 2026-06-18T10:28:59.820+00:00

endedAtstring date-time

The date and time when the campaign stopped, in ISO 8601 format. For example, 2026-06-18T10:28:59.820+00:00.

idstring required

The unique identifier of the donation campaign. This value is generated by Adyen.

namestring required

The name of the donation campaign.

status'active' | 'inactive' | 'ended' required

Changes