Update an appeal

PATCH

https://{organization}.rescueconsole.com

api

fundraising

appeals

{id}

Update an appeal

curl --request PATCH \
  --url https://{organization}.rescueconsole.com/api/fundraising/appeals/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "code": "<string>",
  "default_campaign_id": "<string>"
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', code: '<string>', default_campaign_id: '<string>'})
};

fetch('https://{organization}.rescueconsole.com/api/fundraising/appeals/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{organization}.rescueconsole.com/api/fundraising/appeals/{id}"

payload = {
    "name": "<string>",
    "code": "<string>",
    "default_campaign_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "name": "<string>",
  "code": "<string>",
  "default_campaign_id": "<string>",
  "default_campaign_name": "<string>",
  "status": "active",
  "raised_cents": 123,
  "donation_count": 123,
  "donor_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

Authorizations

Authorization

string

header

required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

string

required

The appeal's record ID.

Body

application/json

name

string

Maximum string length: 120

code

string | null

Maximum string length: 40

default_campaign_id

string | null

status

enum<string>

archived takes it off your donation form and out of the pickers, and leaves it on every gift that named it. Nothing here is deleted.

Available options:

active,

archived

Response

The appeal as it now is.

AN APPEAL IS AN ATTRIBUTION CHOSEN BY THE ORGANIZATION: what made somebody give, such as a mailing or an email. It never appears on a public page and restricts nothing. Not to be confused with a fund; see Fund.

string

name

string

Maximum string length: 120

code

string | null

The organization's own reference. No two of their appeals may share one.

Maximum string length: 40

default_campaign_id

string | null

The campaign a gift naming this appeal joins when the gift names no campaign. Applied when the gift is CREATED, and never on an edit: changing this later does not touch gifts already recorded.

default_campaign_name

string | null

status

enum<string>

archived takes it off your donation form and out of the pickers, and leaves it on every gift that named it. Nothing here is deleted.

Available options:

active,

archived

raised_cents

integer

The total of completed gifts that name it, in whole cents. Pending, failed and refunded gifts do not count, and deleted ones are excluded.

donation_count

integer

donor_count

integer

How many different people gave them. A gift with no person on it counts towards raised_cents but not here.

created_at

string<date-time>

updated_at

string<date-time>

⌘I

Update an appeal

curl --request PATCH \
  --url https://{organization}.rescueconsole.com/api/fundraising/appeals/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "code": "<string>",
  "default_campaign_id": "<string>"
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', code: '<string>', default_campaign_id: '<string>'})
};

fetch('https://{organization}.rescueconsole.com/api/fundraising/appeals/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{organization}.rescueconsole.com/api/fundraising/appeals/{id}"

payload = {
    "name": "<string>",
    "code": "<string>",
    "default_campaign_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "name": "<string>",
  "code": "<string>",
  "default_campaign_id": "<string>",
  "default_campaign_name": "<string>",
  "status": "active",
  "raised_cents": 123,
  "donation_count": 123,
  "donor_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

{
  "error": "house_trained must be 1, 0 or null (not assessed)"
}

Using the API

Endpoints

Authorizations

Path Parameters

Body

Response