Record that a church accepted your document
Per church, the record you already keep: which document the church
accepted, which version, when and how. Send it for your existing base
and for every new church. Identify the church by its Roster church_id
or, before it is registered, by your own church_reference — the same
value you later send as reference when registering the church, and
the two are joined. Repeating (same church, document and version)
returns the original record. Consent is not withdrawn: if you stop
working with a church, remove the Roster button from her site and tell
us.
Headers
- Type: stringIdempotency
- Key min length:1max length:255requiredRequired on every POST, before any effect: 1–255 visible ASCII characters, no spaces. The key belongs to the first body sent with it on this operation for 30 days from the moment that request arrives, including while that request is running and after a
5xxor a timeout. On an operation that creates a resource (POST /v1/churches,POST /v1/churches/import,POST /v1/church_consents,POST /v1/donor_sessions,POST /v1/manage_sessions,POST /v1/refundsandPOST /v1/webhook_endpoints), a key whose request succeeded keeps its body for as long as the resource it created exists. A creation replayed with the same key and body returns the original resource with200and changes nothing; a4xxreleases the key.
Body·
- Type: stringFormat: date-timeaccepted
_at requiredWhen the church accepted: an RFC 3339 date-time with a time zone, such as
2026-08-20T10:00:00Zor2026-08-20T07:00:00-03:00. From 1970 on and not in the future. A date that does not exist on the calendar, a date without a time, or a time without a zone gets400; it is never read as another date. Returned in UTC. - Type: stringchurch
_id min length:1max length:64requiredThe Roster church id. Exactly one of
church_idorchurch_reference. - Type: stringdocumentmin length:1max length:120required
What the church accepted — your name for it (terms, addendum, opt-in). Free text; it is yours to define.
- Type: stringenummethodrequired
How the acceptance was obtained.
valuesterms_of_servicesigned_addendumin_product_optinother - Type: stringversionmin length:1max length:40required
Version of the agreement the church accepted.
- Type: stringchurch
_reference min length:1max length:120Your own id for a church not registered yet. Exactly one of
church_idorchurch_reference. - Type: stringreferencemax length:120
The id of the acceptance record in your system.
Responses
- application/json
- application/json
- application/problem+json
- application/problem+json
- application/problem+json
- application/problem+json
- application/problem+json
curl https://api.sandbox.rostergiving.com/v1/church_consents \
--request POST \
--header 'Idempotency-Key: ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"church_id": "",
"church_reference": "",
"document": "",
"version": "",
"accepted_at": "2026-08-20T10:00:00Z",
"method": "terms_of_service",
"reference": ""
}'
{
"church_id": "string",
"church_reference": "string",
"document": "string",
"version": "string",
"accepted_at": "2026-10-22T14:55:08.129Z",
"method": "terms_of_service",
"reference": "string",
"received_at": "2026-10-22T14:55:08.129Z"
}