Campaigns
update campaign
Updates the campaign with the new data
For custom components:
RaiselyComponents.api.one('campaigns', '{campaign}').patch(data = {}, params = {}, headers = {}) => Promise<{result}>
:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper
patch/campaigns/{campaign}
Path parameters
campaignstring required
The uuid, path or domain of the campaign to associate with the request
Query parameters
privateboolean
Returns the full record when authenticated
Headers
Authorizationstring
A valid HTTP Bearer token, required to access private records.
Request body
Example request
{
"data": {
"allowExperiments": true,
"currency": "AUD",
"mode": "LIVE",
"name": "<< campaign name >>",
"path": "run-for-a-cure",
"private": {
"fieldA": "one",
"fieldB": "yes"
},
"public": {
"fieldA": "one",
"fieldB": "yes"
},
"publicKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"theme": "donation-basic",
"urls": [
"yourdomain.com"
],
"version": "3.0.0"
}
}Response
The campaign record after update
Example response
{
"data": {
"allowExperiments": true,
"currency": "AUD",
"mode": "LIVE",
"name": "<< campaign name >>",
"path": "run-for-a-cure",
"private": {
"fieldA": "one",
"fieldB": "yes"
},
"public": {
"fieldA": "one",
"fieldB": "yes"
},
"publicKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"theme": "donation-basic",
"urls": [
"yourdomain.com"
],
"version": "3.0.0"
}
}