Skip to content

Send an email to the constituent associated with the need

POST
/api/needs/{id}/email
curl --request POST \
--url https://example.com/api/needs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/email \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "subject": "Dream Center Connect - Integration Test", "body": "This is a test notification confirming email integration settings." }'
id
required
string format: uuid
Media typeapplication/json
object
subject
required

Email subject header line.

string
Example
Dream Center Connect - Integration Test
body
required

Email body text or HTML payload.

string
Example
This is a test notification confirming email integration settings.

Email sent successfully

Media typeapplication/json
object
interactionId

Unique identifier (UUID v4) of the recorded interaction note or message.

string format: uuid
messageId

Unique identifier (UUID v4) of the dispatched communication message.

string
Example
{
"interactionId": "70000000-0000-0000-0000-000000000007",
"messageId": "80000000-0000-0000-0000-000000000008"
}

Bad request (e.g. need has no constituent, constituent has no email, etc.)

Unauthorized

Forbidden

Need not found