Change an event

curl --request PATCH \
  --url https://{organization}.rescueconsole.com/api/events/events/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "scheduled",
  "is_public": true,
  "venue_organization_id": "5b8e0f2a-6c4d-4a1e-8b3f-9d2c7e1a0f54"
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    status: 'scheduled',
    is_public: true,
    venue_organization_id: '5b8e0f2a-6c4d-4a1e-8b3f-9d2c7e1a0f54'
  })
};

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

import requests

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

payload = {
    "status": "scheduled",
    "is_public": True,
    "venue_organization_id": "5b8e0f2a-6c4d-4a1e-8b3f-9d2c7e1a0f54"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "event": {
    "name": "<string>",
    "starts_at": "<string>",
    "all_day": true,
    "status": "draft",
    "is_public": true,
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "summary": "<string>",
    "description": "<string>",
    "kind": "adoption",
    "ends_at": "<string>",
    "location_unit_id": "<string>",
    "venue_organization_id": "<string>",
    "venue_name": "<string>",
    "venue_address": "<string>",
    "registration_url": "<string>",
    "form_slug": "<string>",
    "shift_schedule_id": "<string>",
    "series_id": "<string>",
    "recurrence": {
      "freq": "daily",
      "interval": 1,
      "by_weekday": [
        3
      ],
      "monthly_by": "date",
      "until": "2023-12-25",
      "count": 51,
      "never_ends": true,
      "tz": "<string>"
    }
  }
}

{
  "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)"
}

Events

Change an event

Send only what changes. null clears an optional field; starts_at cannot be cleared. To publish an event, send is_public: true with a status of scheduled; to take it off your public site, send is_public: false, or set the status to draft or cancelled. With scope=series, the change is made to every occurrence of the series that has not been deleted, past ones included, except the dates: those change one occurrence at a time. A series’ recurrence cannot be changed. Needs write on Events.

PATCH

api

events

{id}

Change an event

curl --request PATCH \
  --url https://{organization}.rescueconsole.com/api/events/events/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "scheduled",
  "is_public": true,
  "venue_organization_id": "5b8e0f2a-6c4d-4a1e-8b3f-9d2c7e1a0f54"
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    status: 'scheduled',
    is_public: true,
    venue_organization_id: '5b8e0f2a-6c4d-4a1e-8b3f-9d2c7e1a0f54'
  })
};

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

import requests

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

payload = {
    "status": "scheduled",
    "is_public": True,
    "venue_organization_id": "5b8e0f2a-6c4d-4a1e-8b3f-9d2c7e1a0f54"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "event": {
    "name": "<string>",
    "starts_at": "<string>",
    "all_day": true,
    "status": "draft",
    "is_public": true,
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "summary": "<string>",
    "description": "<string>",
    "kind": "adoption",
    "ends_at": "<string>",
    "location_unit_id": "<string>",
    "venue_organization_id": "<string>",
    "venue_name": "<string>",
    "venue_address": "<string>",
    "registration_url": "<string>",
    "form_slug": "<string>",
    "shift_schedule_id": "<string>",
    "series_id": "<string>",
    "recurrence": {
      "freq": "daily",
      "interval": 1,
      "by_weekday": [
        3
      ],
      "monthly_by": "date",
      "until": "2023-12-25",
      "count": 51,
      "never_ends": true,
      "tz": "<string>"
    }
  }
}

{
  "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 event's ID.

Query Parameters

scope

enum<string>

series to change every occurrence of this event's series. Ignored for an event that is not in a series.

Available options:

series

Body

application/json

name

string

Maximum string length: 120

summary

string | null

A line or two about it.

Maximum string length: 300

description

string | null

Maximum string length: 8000

kind

enum<string> | null

The same kinds Shifts uses. events is shown as Event.

Available options:

adoption,

fundraiser,

clinic,

transport,

training,

meeting,

events,

other

starts_at

string

A date, YYYY-MM-DD, for an all-day event, or a timestamp for a timed one.

ends_at

string | null

A date or a timestamp, like starts_at. Refused if it is before a starts_at sent with it.

all_day

boolean

Whether it is an all-day event. Send bare dates in starts_at and ends_at for one.

location_unit_id

string | null

One of your own locations, when it is held at one.

venue_organization_id

string | null

One of your organizations, when it is held at one. Its name and address are copied into venue_name and venue_address. Clearing it leaves those as they are.

venue_name

string | null

Maximum string length: 200

venue_address

string | null

The address, on one line.

Maximum string length: 500

status

enum<string>

Available options:

draft,

scheduled,

cancelled,

completed

is_public

boolean

Whether your public site may show it. It shows an event that is public and scheduled or completed.

registration_url

string | null

Where people sign up, an http or https address. An address with no scheme is given https://.

form_slug

string | null

The address of one of your own published forms, for people to sign up with. Lowercase letters, digits and hyphens. Whether the form exists is not checked.

Pattern: ^[a-z0-9](?:[a-z0-9-]{0,58}[a-z0-9])?$

shift_schedule_id

string | null

The Shifts schedule that covers it. Adding volunteer coverage sets this for you.

Response

This event, as it now is.

event

object

Show child attributes

Using the API

Endpoints

Change an event

Authorizations

Path Parameters

Query Parameters

Body

Response