Newsletter

get

Authorizations

jwtAuth

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Query parameters

limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

Responses

200Success

application/json

countintegerRequiredExample: 123

nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?offset=400&limit=100

previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?offset=200&limit=100

get

/api/newsletter

HTTPcURLJavaScriptPython

GET /api/newsletter HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
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",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-04-04T01:54:26.755Z",
      "updated_at": "2026-04-04T01:54:26.755Z",
      "email": "[email protected]"
    }
  ]
}

post

Authorizations

jwtAuth

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

idstring · uuidRead-onlyRequired

legacy_idstring · nullableOptional

nextgen_legacy_idstring · nullableOptional

created_atstring · date-time · nullableOptional

updated_atstring · date-timeRead-onlyRequired

emailstring · email · max: 254Required

Responses

201Success

application/json

post

/api/newsletter

HTTPcURLJavaScriptPython

POST /api/newsletter HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-04-04T01:54:26.755Z",
  "email": "[email protected]"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

201Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-04-04T01:54:26.755Z",
  "updated_at": "2026-04-04T01:54:26.755Z",
  "email": "[email protected]"
}

get

Authorizations

jwtAuth

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this newsletter.

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

legacy_idstring · nullableOptional

nextgen_legacy_idstring · nullableOptional

created_atstring · date-time · nullableOptional

updated_atstring · date-timeRead-onlyRequired

emailstring · email · max: 254Required

get

/api/newsletter/{id}

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-04-04T01:54:26.755Z",
  "updated_at": "2026-04-04T01:54:26.755Z",
  "email": "[email protected]"
}

put

Authorizations

jwtAuth

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this newsletter.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

idstring · uuidRead-onlyRequired

legacy_idstring · nullableOptional

nextgen_legacy_idstring · nullableOptional

created_atstring · date-time · nullableOptional

updated_atstring · date-timeRead-onlyRequired

emailstring · email · max: 254Required

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

legacy_idstring · nullableOptional

nextgen_legacy_idstring · nullableOptional

created_atstring · date-time · nullableOptional

updated_atstring · date-timeRead-onlyRequired

emailstring · email · max: 254Required

put

/api/newsletter/{id}

HTTPcURLJavaScriptPython

PUT /api/newsletter/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-04-04T01:54:26.755Z",
  "email": "[email protected]"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-04-04T01:54:26.755Z",
  "updated_at": "2026-04-04T01:54:26.755Z",
  "email": "[email protected]"
}

delete

Authorizations

jwtAuth

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this newsletter.

Responses

204

No response body

delete

/api/newsletter/{id}

HTTPcURLJavaScriptPython

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

204

No response body

No content

patch

Authorizations

jwtAuth

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

A UUID string identifying this newsletter.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

idstring · uuidRead-onlyOptional

legacy_idstring · nullableOptional

nextgen_legacy_idstring · nullableOptional

created_atstring · date-time · nullableOptional

updated_atstring · date-timeRead-onlyOptional

emailstring · email · max: 254Optional

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

legacy_idstring · nullableOptional

nextgen_legacy_idstring · nullableOptional

created_atstring · date-time · nullableOptional

updated_atstring · date-timeRead-onlyRequired

emailstring · email · max: 254Required

patch

/api/newsletter/{id}

HTTPcURLJavaScriptPython

PATCH /api/newsletter/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-04-04T01:54:26.755Z",
  "email": "[email protected]"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-04-04T01:54:26.755Z",
  "updated_at": "2026-04-04T01:54:26.755Z",
  "email": "[email protected]"
}