Update a fund

PATCH

https://{organization}.rescueconsole.com

api

fundraising

funds

{id}

Update a fund

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

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

fetch('https://{organization}.rescueconsole.com/api/fundraising/funds/{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/funds/{id}"

payload = {
    "name": "<string>",
    "code": "<string>",
    "description": "<string>",
    "sort_order": 123,
    "is_public": True
}
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>",
  "description": "<string>",
  "sort_order": 123,
  "is_public": true,
  "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 fund's record ID.

Body

application/json

name

string

Maximum string length: 120

code

string | null

Maximum string length: 40

description

string | null

sort_order

integer

is_public

boolean

default:true

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 fund as it now is.

A FUND IS A RESTRICTION CHOSEN BY THE GIVER: what they said their money is for. Funds marked is_public appear on the organization's donation form, and a gift naming one is restricted to it. Not to be confused with an appeal, which is chosen by the organization; see Appeal.

string

name

string

What the giver reads on the donation form.

Maximum string length: 120

code

string | null

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

Maximum string length: 40

description

string | null

One line under the name on the form: what the fund pays for.

sort_order

integer

The order funds are offered in. Lower first, then by name.

is_public

boolean

Whether it appears on the donation form. False for a fund that exists only for the books.

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 a fund

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

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

fetch('https://{organization}.rescueconsole.com/api/fundraising/funds/{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/funds/{id}"

payload = {
    "name": "<string>",
    "code": "<string>",
    "description": "<string>",
    "sort_order": 123,
    "is_public": True
}
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>",
  "description": "<string>",
  "sort_order": 123,
  "is_public": true,
  "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