PATCH /companies/{companyId}/campaignManagement/{donationCampaignId}
Updates the properties of the donation campaign specified in the path. Note the following restrictions:
- You cannot use a PATCH request to update the campaign status. To activate or end a campaign, make a POST request to the
/campaignManagement/{campaignId}/status/{status}endpoint. - You get a validation error if you add account holders that are not compatible with the nonprofit.
To make this request, your API credential must have the following role:
- Management API—Campaign Management read and write
Servers
- https://management-test.adyen.com/v3
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 be updated. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
online |
Object | No |
The settings for online donations collected as part of the campaign. |
name |
String | No |
The name of the donation campaign. |
accountHolderIds[] |
Array | No |
The unique identifiers of the account holders associated with the donation campaign. |
inPerson |
Object | No |
The settings for in-person donations collected as part of the campaign. |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.