POST
/
frontend
/
donor
/
dashboard
/
entity
/
compose_message
/
{client_id}
/
{program_id}
/
{entity_id}
/
{parent_id}
/
{session_id}
curl --request POST \
  --url https://api.helpyousponsor.com/v1/frontend/donor/dashboard/entity/compose_message/{client_id}/{program_id}/{entity_id}/{parent_id}/{session_id} \
  --header 'Content-Type: application/json' \
  --header 'session_id: <api-key>' \
  --data '{
  "subject": "Subject of Message",
  "message": "Message content"
}'
{
  "status": "success",
  "redirect": "<string>"
}

Authorizations

​
session_id
string
header
required

Use a session id to authenticate

Path Parameters

​
client_id
integer
required

Client ID associated with the donor

​
program_id
integer
required

Program ID associated with the donor

​
entity_id
integer
required

Entity ID for which the message is intended

​
parent_id
string
required

Parent ID for the message thread

Example:

"1 or undefined"

​
session_id
string
required

Session ID for the donor

Body

application/json

Message data from donor

The body is of type object.

Response

200
application/json

Message sent successfully

The response is of type object.