EmailTemplate - Services API

Example Request

curl https://api.planningcenteronline.com/services/v2/email_templates

View in API Explorer →

Example Object

{
  "type": "EmailTemplate",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "html_body": "string",
    "kind": "string",
    "subject": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "template_owner": {
      "data": {
        "type": "Organization",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`created_at`	`date_time`
`html_body`	`string`
`id`	`primary_key`
`kind`	`string`
`subject`	`string`
`updated_at`	`date_time`

Relationships

Name	Type	Association Type	Note
template_owner	Organization	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/email_templates`

Reading

HTTP Method	Endpoint
GET	`/services/v2/email_templates/{id}`

Creating

HTTP Method	Endpoint	Assignable Attributes
POST	`/services/v2/email_templates`	html_body subject kind

Updating

HTTP Method	Endpoint	Assignable Attributes
PATCH	`/services/v2/email_templates/{id}`	html_body subject

Deleting

HTTP Method	Endpoint
DELETE	`/services/v2/email_templates/{id}`

Actions

HTTP Method	Endpoint	Description
POST	`https://api.planningcenteronline.com/services/v2/email_templates/{email_template_id}/render`	Render an email template and fill in the persons details

Belongs To

HTTP Method	Endpoint	Association	Details	Filter By
GET	`https://api.planningcenteronline.com/services/v2/email_templates`	Organization