Message transactions

get
Authorizations
Query parameters
pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

Responses
200Success
application/json
get
GET /api/unified-communications/message-transactions HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "user": {
        "id": "text",
        "email": "text",
        "phone": "text",
        "profile": "text",
        "additional_user_fields": "text"
      },
      "recipients": "text",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2025-07-23T12:22:54.919Z",
      "updated_at": "2025-07-23T12:22:54.919Z",
      "transaction_id": 1,
      "credits": 1,
      "valid_recipients_count": 1,
      "invalid_recipients_count": 1,
      "message_content": "text",
      "media_urls": null,
      "voice_url": "https://example.com",
      "send_at": "2025-07-23T12:22:54.919Z",
      "sender_phone": "text",
      "sender_email": "[email protected]",
      "sender_name": "[email protected]",
      "type": "sms",
      "status": "scheduled",
      "message_type": "personalize_message",
      "celery_task_id": "text",
      "subject": "text",
      "target_page": "text",
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}
post
Authorizations
Body
idstring · uuidRead-onlyRequired
userall ofRead-onlyRequired
recipientsstringRead-onlyRequired
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableOptional
updated_atstring · date-timeRead-onlyRequired
transaction_idintegerRead-onlyRequired
creditsinteger · min: -2147483648 · max: 2147483647Required
valid_recipients_countinteger · max: 2147483647Optional
invalid_recipients_countinteger · max: 2147483647Optional
message_contentstring | nullableOptional
media_urlsany | nullableOptional
voice_urlstring · uri | nullableOptional
send_atstring · date-time | nullableOptional
sender_phonestring | nullableOptional
sender_emailstring · email | nullableOptional
sender_namestring · email | nullableOptional
typestring · enumOptional
  • sms - SMS
  • mms - MMS
  • voice - Voice
  • push_notification - Push Notification
  • email - Email
Possible values:
statusstring · enumOptional
  • scheduled - Scheduled
  • sent - Sent
  • failed - Failed
Possible values:
message_typestring · enumRequired
  • personalize_message - Personalize Message
  • general_message - General Message
Possible values:
celery_task_idstring | nullableOptional
subjectstring | nullableOptional
target_pagestring | nullableOptional
churchstring · uuidRequired
Responses
201Success
application/json
post
POST /api/unified-communications/message-transactions HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 535

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:22:54.919Z",
  "credits": 1,
  "valid_recipients_count": 1,
  "invalid_recipients_count": 1,
  "message_content": "text",
  "media_urls": null,
  "voice_url": "https://example.com",
  "send_at": "2025-07-23T12:22:54.919Z",
  "sender_phone": "text",
  "sender_email": "[email protected]",
  "sender_name": "[email protected]",
  "type": "sms",
  "status": "scheduled",
  "message_type": "personalize_message",
  "celery_task_id": "text",
  "subject": "text",
  "target_page": "text",
  "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"
  },
  "recipients": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:22:54.919Z",
  "updated_at": "2025-07-23T12:22:54.919Z",
  "transaction_id": 1,
  "credits": 1,
  "valid_recipients_count": 1,
  "invalid_recipients_count": 1,
  "message_content": "text",
  "media_urls": null,
  "voice_url": "https://example.com",
  "send_at": "2025-07-23T12:22:54.919Z",
  "sender_phone": "text",
  "sender_email": "[email protected]",
  "sender_name": "[email protected]",
  "type": "sms",
  "status": "scheduled",
  "message_type": "personalize_message",
  "celery_task_id": "text",
  "subject": "text",
  "target_page": "text",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}
get
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this message transaction.

Responses
200Success
application/json
get
GET /api/unified-communications/message-transactions/{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"
  },
  "recipients": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:22:54.919Z",
  "updated_at": "2025-07-23T12:22:54.919Z",
  "transaction_id": 1,
  "credits": 1,
  "valid_recipients_count": 1,
  "invalid_recipients_count": 1,
  "message_content": "text",
  "media_urls": null,
  "voice_url": "https://example.com",
  "send_at": "2025-07-23T12:22:54.919Z",
  "sender_phone": "text",
  "sender_email": "[email protected]",
  "sender_name": "[email protected]",
  "type": "sms",
  "status": "scheduled",
  "message_type": "personalize_message",
  "celery_task_id": "text",
  "subject": "text",
  "target_page": "text",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}
put
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this message transaction.

Body
idstring · uuidRead-onlyRequired
userall ofRead-onlyRequired
recipientsstringRead-onlyRequired
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableOptional
updated_atstring · date-timeRead-onlyRequired
transaction_idintegerRead-onlyRequired
creditsinteger · min: -2147483648 · max: 2147483647Required
valid_recipients_countinteger · max: 2147483647Optional
invalid_recipients_countinteger · max: 2147483647Optional
message_contentstring | nullableOptional
media_urlsany | nullableOptional
voice_urlstring · uri | nullableOptional
send_atstring · date-time | nullableOptional
sender_phonestring | nullableOptional
sender_emailstring · email | nullableOptional
sender_namestring · email | nullableOptional
typestring · enumOptional
  • sms - SMS
  • mms - MMS
  • voice - Voice
  • push_notification - Push Notification
  • email - Email
Possible values:
statusstring · enumOptional
  • scheduled - Scheduled
  • sent - Sent
  • failed - Failed
Possible values:
message_typestring · enumRequired
  • personalize_message - Personalize Message
  • general_message - General Message
Possible values:
celery_task_idstring | nullableOptional
subjectstring | nullableOptional
target_pagestring | nullableOptional
churchstring · uuidRequired
Responses
200Success
application/json
put
PUT /api/unified-communications/message-transactions/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 535

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:22:54.919Z",
  "credits": 1,
  "valid_recipients_count": 1,
  "invalid_recipients_count": 1,
  "message_content": "text",
  "media_urls": null,
  "voice_url": "https://example.com",
  "send_at": "2025-07-23T12:22:54.919Z",
  "sender_phone": "text",
  "sender_email": "[email protected]",
  "sender_name": "[email protected]",
  "type": "sms",
  "status": "scheduled",
  "message_type": "personalize_message",
  "celery_task_id": "text",
  "subject": "text",
  "target_page": "text",
  "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"
  },
  "recipients": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:22:54.919Z",
  "updated_at": "2025-07-23T12:22:54.919Z",
  "transaction_id": 1,
  "credits": 1,
  "valid_recipients_count": 1,
  "invalid_recipients_count": 1,
  "message_content": "text",
  "media_urls": null,
  "voice_url": "https://example.com",
  "send_at": "2025-07-23T12:22:54.919Z",
  "sender_phone": "text",
  "sender_email": "[email protected]",
  "sender_name": "[email protected]",
  "type": "sms",
  "status": "scheduled",
  "message_type": "personalize_message",
  "celery_task_id": "text",
  "subject": "text",
  "target_page": "text",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}
delete
Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this message transaction.

Responses
204
No response body
delete
DELETE /api/unified-communications/message-transactions/{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 message transaction.

Body
idstring · uuidRead-onlyOptional
userall ofRead-onlyOptional
recipientsstringRead-onlyOptional
legacy_idstring | nullableOptional
nextgen_legacy_idstring | nullableOptional
created_atstring · date-time | nullableOptional
updated_atstring · date-timeRead-onlyOptional
transaction_idintegerRead-onlyOptional
creditsinteger · min: -2147483648 · max: 2147483647Optional
valid_recipients_countinteger · max: 2147483647Optional
invalid_recipients_countinteger · max: 2147483647Optional
message_contentstring | nullableOptional
media_urlsany | nullableOptional
voice_urlstring · uri | nullableOptional
send_atstring · date-time | nullableOptional
sender_phonestring | nullableOptional
sender_emailstring · email | nullableOptional
sender_namestring · email | nullableOptional
typestring · enumOptional
  • sms - SMS
  • mms - MMS
  • voice - Voice
  • push_notification - Push Notification
  • email - Email
Possible values:
statusstring · enumOptional
  • scheduled - Scheduled
  • sent - Sent
  • failed - Failed
Possible values:
message_typestring · enumOptional
  • personalize_message - Personalize Message
  • general_message - General Message
Possible values:
celery_task_idstring | nullableOptional
subjectstring | nullableOptional
target_pagestring | nullableOptional
churchstring · uuidOptional
Responses
200Success
application/json
patch
PATCH /api/unified-communications/message-transactions/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 535

{
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:22:54.919Z",
  "credits": 1,
  "valid_recipients_count": 1,
  "invalid_recipients_count": 1,
  "message_content": "text",
  "media_urls": null,
  "voice_url": "https://example.com",
  "send_at": "2025-07-23T12:22:54.919Z",
  "sender_phone": "text",
  "sender_email": "[email protected]",
  "sender_name": "[email protected]",
  "type": "sms",
  "status": "scheduled",
  "message_type": "personalize_message",
  "celery_task_id": "text",
  "subject": "text",
  "target_page": "text",
  "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"
  },
  "recipients": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2025-07-23T12:22:54.919Z",
  "updated_at": "2025-07-23T12:22:54.919Z",
  "transaction_id": 1,
  "credits": 1,
  "valid_recipients_count": 1,
  "invalid_recipients_count": 1,
  "message_content": "text",
  "media_urls": null,
  "voice_url": "https://example.com",
  "send_at": "2025-07-23T12:22:54.919Z",
  "sender_phone": "text",
  "sender_email": "[email protected]",
  "sender_name": "[email protected]",
  "type": "sms",
  "status": "scheduled",
  "message_type": "personalize_message",
  "celery_task_id": "text",
  "subject": "text",
  "target_page": "text",
  "church": "123e4567-e89b-12d3-a456-426614174000"
}
PreviousContactsNextWebhook