Newsletter
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/newsletter 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",
"legacy_id": "text",
"nextgen_legacy_id": "text",
"created_at": "2025-07-23T12:14:00.365Z",
"updated_at": "2025-07-23T12:14:00.365Z",
"email": "[email protected]"
}
]
}post
Authorizations
Body
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
POST /api/newsletter HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 112
{
"legacy_id": "text",
"nextgen_legacy_id": "text",
"created_at": "2025-07-23T12:14:00.365Z",
"email": "[email protected]"
}201Success
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"legacy_id": "text",
"nextgen_legacy_id": "text",
"created_at": "2025-07-23T12:14:00.365Z",
"updated_at": "2025-07-23T12:14:00.365Z",
"email": "[email protected]"
}get
Authorizations
Path parameters
idstring · uuidRequired
A UUID string identifying this newsletter.
Responses
200Success
application/json
get
GET /api/newsletter/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*
200Success
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"legacy_id": "text",
"nextgen_legacy_id": "text",
"created_at": "2025-07-23T12:14:00.365Z",
"updated_at": "2025-07-23T12:14:00.365Z",
"email": "[email protected]"
}put
Authorizations
Path parameters
idstring · uuidRequired
A UUID string identifying this newsletter.
Body
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
put
PUT /api/newsletter/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 112
{
"legacy_id": "text",
"nextgen_legacy_id": "text",
"created_at": "2025-07-23T12:14:00.365Z",
"email": "[email protected]"
}200Success
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"legacy_id": "text",
"nextgen_legacy_id": "text",
"created_at": "2025-07-23T12:14:00.365Z",
"updated_at": "2025-07-23T12:14:00.365Z",
"email": "[email protected]"
}delete
Authorizations
Path parameters
idstring · uuidRequired
A UUID string identifying this newsletter.
Responses
204
No response body
delete
DELETE /api/newsletter/{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 newsletter.
Body
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
patch
PATCH /api/newsletter/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 112
{
"legacy_id": "text",
"nextgen_legacy_id": "text",
"created_at": "2025-07-23T12:14:00.365Z",
"email": "[email protected]"
}200Success
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"legacy_id": "text",
"nextgen_legacy_id": "text",
"created_at": "2025-07-23T12:14:00.365Z",
"updated_at": "2025-07-23T12:14:00.365Z",
"email": "[email protected]"
}