curl --request POST \
--url https://{organization}.rescueconsole.com/api/people/persons/bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "add_role",
"value": "volunteer",
"ids": [
"6f1c2b0e-8d4a-4c1e-9b7a-2e5d1f3a9c10",
"a3d9e7f2-1b6c-4e8d-9f0a-5c2b7e1d4f36"
]
}
'{
"updated": 123,
"action": "<string>",
"value": "<string>",
"unchanged": 123
}{
"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)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Change many people at once
One change applied to as many as 200 people, chosen by ID or by a filter. Everything is checked before anything is written: if any part is refused, nobody changes. Send exactly one of ids or filter. A filter is the same query string the list takes, and is refused when it matches nobody or more than 200 people. People who already have the value are counted as unchanged and get no history entry. The actions: set_status (value: active, inactive or archived); add_role and remove_role (value: a role; the other roles are kept); update (patch: status and phone_country only); delete (the same as deleting each one, and refused with 409 if any of them can sign in to your organization). Needs write on People, including to delete.
curl --request POST \
--url https://{organization}.rescueconsole.com/api/people/persons/bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "add_role",
"value": "volunteer",
"ids": [
"6f1c2b0e-8d4a-4c1e-9b7a-2e5d1f3a9c10",
"a3d9e7f2-1b6c-4e8d-9f0a-5c2b7e1d4f36"
]
}
'{
"updated": 123,
"action": "<string>",
"value": "<string>",
"unchanged": 123
}{
"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)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Authorizations
An API key from Settings, API keys. It starts with rc_live_.
Body
set_status, add_role, remove_role, update, delete For set_status, a status. For add_role and remove_role, a role. Not used by update or delete.
For update only: the fields to set on every one of them.
Show child attributes
Show child attributes
The people to change. Every one must exist, or nothing changes (404).
200Everybody the list would show for this query string, such as role=donor&status=active. At most 200 may match.