API
⌘K
My Developer Account

CustomSlide

A CustomSlide is used for adding text intended for display on a screen.

Example Request

curl https://api.planningcenteronline.com/services/v2/songs/{song_id}/last_scheduled_item/{last_scheduled_item_id}/custom_slides

View in API Explorer →

Example Object

{
  "type": "CustomSlide",
  "id": "1",
  "attributes": {
    "body": "string",
    "enabled": true,
    "label": "string",
    "order": 1
  },
  "relationships": {
    "item": {
      "data": {
        "type": "Item",
        "id": "1"
      }
    },
    "attachment": {
      "data": {
        "type": "Attachment",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
body string
enabled boolean
id primary_key
label string
order integer

Relationships

Name Type Association Type Note
item Item to_one
attachment Attachment to_one

Pagination

Name Parameter Type Description
per_page per_page integer how many records to return per page (min=1, max=100, default=25)
offset offset integer get results from given offset

Endpoints

Listing

HTTP Method Endpoint
GET /services/v2/songs/{song_id}/last_scheduled_item/{last_scheduled_item_id}/custom_slides

Reading

HTTP Method Endpoint
GET /services/v2/songs/{song_id}/last_scheduled_item/{last_scheduled_item_id}/custom_slides/{id}

Creating

HTTP Method Endpoint Assignable Attributes
POST /services/v2/service_types/{service_type_id}/plans/{plan_id}/items/{item_id}/custom_slides
  • body
  • enabled
  • label
  • order

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /services/v2/songs/{song_id}/last_scheduled_item/{last_scheduled_item_id}/custom_slides/{id}
  • body
  • enabled
  • label
  • order

Deleting

HTTP Method Endpoint
DELETE /services/v2/songs/{song_id}/last_scheduled_item/{last_scheduled_item_id}/custom_slides/{id}

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/services/v2/service_types/{service_type_id}/plans/{plan_id}/items/{item_id}/custom_slides Item