Templates | ChurchPad Documentation

get

Authorizations

Query parameters

limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

Responses

200Success

application/json

get

GET /api/church/templates HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "user": {
        "id": "text",
        "email": "text",
        "phone": "text",
        "profile": "text",
        "additional_user_fields": "text"
      },
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:51:21.762Z",
      "updated_at": "2025-07-23T12:51:21.762Z",
      "name": "text",
      "sender_name": "text",
      "sender_email": "[email protected]",
      "subject": "text",
      "content": "text",
      "type": "email",
      "is_automated": true,
      "celebration_type": "text",
      "send_at": "12:51:21",
      "media": null,
      "voice_url": "https://example.com",
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

post

Authorizations

Body

idstring · uuidRead-onlyRequired

userall ofRead-onlyRequired

legacy_idstring | nullableOptional

nextgen_legacy_idstring | nullableOptional

created_atstring · date-time | nullableOptional

updated_atstring · date-timeRead-onlyRequired

namestring · max: 100Required

sender_namestring | nullableOptional

sender_emailstring · email | nullableOptional

subjectstring · max: 255Required

contentstringRequired

typestring · enumRequired

email - Email
push_notification - Push Notification
sms - SMS
mms - MMS
voice - Voice

Possible values:

is_automatedbooleanOptional

celebration_typestring | nullableOptional

send_atstring · time | nullableOptional

mediaany | nullableOptional

voice_urlstring · uri | nullableOptional

churchstring · uuidRequired

Responses

201Success

application/json

post

POST /api/church/templates HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 365

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:51:21.762Z",
  "name": "text",
  "sender_name": "text",
  "sender_email": "[email protected]",
  "subject": "text",
  "content": "text",
  "type": "email",
  "is_automated": true,
  "celebration_type": "text",
  "send_at": "12:51:21",
  "media": null,
  "voice_url": "https://example.com",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

201Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:51:21.762Z",
  "updated_at": "2025-07-23T12:51:21.762Z",
  "name": "text",
  "sender_name": "text",
  "sender_email": "[email protected]",
  "subject": "text",
  "content": "text",
  "type": "email",
  "is_automated": true,
  "celebration_type": "text",
  "send_at": "12:51:21",
  "media": null,
  "voice_url": "https://example.com",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

get

Authorizations

Path parameters

idstring · uuidRequired

A UUID string identifying this template.

Responses

200Success

application/json

get

GET /api/church/templates/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:51:21.762Z",
  "updated_at": "2025-07-23T12:51:21.762Z",
  "name": "text",
  "sender_name": "text",
  "sender_email": "[email protected]",
  "subject": "text",
  "content": "text",
  "type": "email",
  "is_automated": true,
  "celebration_type": "text",
  "send_at": "12:51:21",
  "media": null,
  "voice_url": "https://example.com",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

put

Authorizations

Path parameters

idstring · uuidRequired

A UUID string identifying this template.

Body

idstring · uuidRead-onlyRequired

userall ofRead-onlyRequired

legacy_idstring | nullableOptional

nextgen_legacy_idstring | nullableOptional

created_atstring · date-time | nullableOptional

updated_atstring · date-timeRead-onlyRequired

namestring · max: 100Required

sender_namestring | nullableOptional

sender_emailstring · email | nullableOptional

subjectstring · max: 255Required

contentstringRequired

typestring · enumRequired

email - Email
push_notification - Push Notification
sms - SMS
mms - MMS
voice - Voice

Possible values:

is_automatedbooleanOptional

celebration_typestring | nullableOptional

send_atstring · time | nullableOptional

mediaany | nullableOptional

voice_urlstring · uri | nullableOptional

churchstring · uuidRequired

Responses

200Success

application/json

put

PUT /api/church/templates/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 365

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:51:21.762Z",
  "name": "text",
  "sender_name": "text",
  "sender_email": "[email protected]",
  "subject": "text",
  "content": "text",
  "type": "email",
  "is_automated": true,
  "celebration_type": "text",
  "send_at": "12:51:21",
  "media": null,
  "voice_url": "https://example.com",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:51:21.762Z",
  "updated_at": "2025-07-23T12:51:21.762Z",
  "name": "text",
  "sender_name": "text",
  "sender_email": "[email protected]",
  "subject": "text",
  "content": "text",
  "type": "email",
  "is_automated": true,
  "celebration_type": "text",
  "send_at": "12:51:21",
  "media": null,
  "voice_url": "https://example.com",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

delete

Authorizations

Path parameters

idstring · uuidRequired

A UUID string identifying this template.

Responses

204

No response body

delete

DELETE /api/church/templates/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*

204

No response body

No content

patch

Authorizations

Path parameters

idstring · uuidRequired

A UUID string identifying this template.

Body

idstring · uuidRead-onlyOptional

userall ofRead-onlyOptional

legacy_idstring | nullableOptional

nextgen_legacy_idstring | nullableOptional

created_atstring · date-time | nullableOptional

updated_atstring · date-timeRead-onlyOptional

namestring · max: 100Optional

sender_namestring | nullableOptional

sender_emailstring · email | nullableOptional

subjectstring · max: 255Optional

contentstringOptional

typestring · enumOptional

email - Email
push_notification - Push Notification
sms - SMS
mms - MMS
voice - Voice

Possible values:

is_automatedbooleanOptional

celebration_typestring | nullableOptional

send_atstring · time | nullableOptional

mediaany | nullableOptional

voice_urlstring · uri | nullableOptional

churchstring · uuidOptional

Responses

200Success

application/json

patch

PATCH /api/church/templates/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 365

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:51:21.762Z",
  "name": "text",
  "sender_name": "text",
  "sender_email": "[email protected]",
  "subject": "text",
  "content": "text",
  "type": "email",
  "is_automated": true,
  "celebration_type": "text",
  "send_at": "12:51:21",
  "media": null,
  "voice_url": "https://example.com",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:51:21.762Z",
  "updated_at": "2025-07-23T12:51:21.762Z",
  "name": "text",
  "sender_name": "text",
  "sender_email": "[email protected]",
  "subject": "text",
  "content": "text",
  "type": "email",
  "is_automated": true,
  "celebration_type": "text",
  "send_at": "12:51:21",
  "media": null,
  "voice_url": "https://example.com",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}