Email

Endpoints for sending emails to patients

Send email

Queues an email for sending on behalf of the practice

Securityapi_key or azure_auth
Request
path Parameters
SiteSlug
required
string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$

The Slipstream slug that uniquely identifies a physical practice

Example: s8n6EzC
Request Body schema: application/json
required

The details of the email to send

PmsSpecificId
required
string

The unique ID of the email in the pms system

required
Array of objects (EmailAddressWithDisplayName)

The recipient email address(es)

Array of objects or null (EmailAddressWithDisplayName)

The cc'd recipient(s) email address

Array of objects or null (EmailAddressWithDisplayName)

The bcc'd recipient(s) email address

Subject
required
string

The subject of the email

Body
required
string

The plain text body of the email

BodyHtml
string or null

The html body of the email

required
object (EmailSenderProperties)

Sender properties to control the the sending of an email

Responses
202

The response of the physical letter sending request

400

Malformed Request (ProblemDetails)

401

Unauthorized - Provide proof of identity (ProblemDetails)

403

Forbidden - Insufficient permissions (ProblemDetails)

404

Not Found - Could not find a matching entity (ProblemDetails)

422

Unprocessable - Request was well formed but could not be actioned (ProblemDetails)

429

Too many requests - Chill out (ProblemDetails)

4XX

User Error (ProblemDetails)

5XX

Server Error (ProblemDetails)

post/sites/{SiteSlug}/email
Request samples
application/json
{
  • "PmsSpecificId": "{064a5f0e-0b0e-4e1e-8e1e-0e0e0e0e0e0e}",
  • "To": [
    ],
  • "Cc": [
    ],
  • "Bcc": [
    ],
  • "Subject": "This is a test email",
  • "Body": "Here is the body of the email",
  • "BodyHtml": "<p>Here is the body of the email</p>",
  • "SenderProperties": {
    }
}
Response samples
application/json
{
  • "Id": "064a5f0e-0b0e-4e1e-8e1e-0e0e0e0e0e0e",
  • "PmsSpecificId": "064a5f0e0b0e4e1e8e1e0e0e0e0e0e0e"
}

Get email status

Gets the status of an email sent on behalf of the practice

Securityapi_key or azure_auth
Request
path Parameters
SiteSlug
required
string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$

The Slipstream slug that uniquely identifies a physical practice

Example: s8n6EzC
EmailId
required
string <uuid>

The Id that uniquely identifies the email in Slipstream

Example: 44088399-d916-4de5-9f0a-dca7b3d07df2
Responses
200

The response of the physical letter sending request

400

Malformed Request (ProblemDetails)

401

Unauthorized - Provide proof of identity (ProblemDetails)

403

Forbidden - Insufficient permissions (ProblemDetails)

404

Not Found - Could not find a matching entity (ProblemDetails)

422

Unprocessable - Request was well formed but could not be actioned (ProblemDetails)

429

Too many requests - Chill out (ProblemDetails)

4XX

User Error (ProblemDetails)

5XX

Server Error (ProblemDetails)

get/sites/{SiteSlug}/email/{EmailId}
Request samples
Response samples
application/json
{
  • "Id": "064a5f0e-0b0e-4e1e-8e1e-0e0e0e0e0e0e",
  • "PmsSpecificId": "064a5f0e0b0e4e1e8e1e0e0e0e0e0e0e",
  • "Status": "Unknown"
}