Queues one or more letters for sending on behalf of the practice
SiteSlug required | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ The Slipstream slug that uniquely identifies a physical practice Example: s8n6EzC |
The details of the letter to send
Express | boolean or null Whether the letter should be sent by express delivery. If omitted, the default is standard delivery. |
DoubleSided | boolean or null Whether the letter should be single or double sided. If omitted, the default is single sided. |
Color | boolean or null Whether the letter should be printed in color. If omitted, the default is black and white. |
PmsSpecificId required | string The unique ID of the letter in the pms system |
ScheduledSendDate | string <date-time> The date to send the letter - omit or blank to send immediately |
required | object or null (Addressee) The name and identity of a person |
required | object (StreetAddress) Information about a street address. |
required | object (DataUri) A URI that can be used to request data (usually files) from the PMS with a GET request. Typical implementations would be:
|
SkipAddressValidation | boolean or null Whether to skip address validation of the recipient address |
property name* additional property | any |
The response of the physical letter sending request
Malformed Request (ProblemDetails)
Unauthorized - Provide proof of identity (ProblemDetails)
Forbidden - Insufficient permissions (ProblemDetails)
Not Found - Could not find a matching entity (ProblemDetails)
Unprocessable - Request was well formed but could not be actioned (ProblemDetails)
Too many requests - Chill out (ProblemDetails)
User Error (ProblemDetails)
Server Error (ProblemDetails)
[- {
- "Express": false,
- "DoubleSided": false,
- "Color": false,
- "PmsSpecificId": "{064a5f0e-0b0e-4e1e-8e1e-0e0e0e0e0e0e}",
- "ScheduledSendDate": "2023-10-24T14:30:15+02:00",
- "Addressee": {
- "PmsSpecificId": "1234567890abcdef1234567890abcdef",
- "GivenName": "John",
- "MiddleName": "Danger Blanket",
- "FamilyName": "Smith",
- "FullName": "Dr John Smith III"
}, - "Address": {
- "AddressLine1": "123 Main St",
- "AddressLine2": "Apt 4",
- "Locality": "San Francisco",
- "Region": "CA",
- "PostalCode": "94107",
- "Country": "USA"
}, - "Pdf": {
- "Id": "12345678-1234-1234-1234-1234567890ab",
- "Expiry": "2021-01-01T00:00:00Z",
- "RequestHeaders": {
- "X-API-KEY": "1234567890abcdef1234567890abcdef",
- "user-agent": "slipstream/1.0.0",
- "x-practice-site": "dentallyuk34554"
}
}, - "SkipAddressValidation": false
}
]
{- "Succeeded": [
- {
- "Id": "064a5f0e-0b0e-4e1e-8e1e-0e0e0e0e0e0e",
- "PmsSpecificId": "064a5f0e-0b0e-4e1e-8e1e-0e0e0e0e0e0e",
- "AddressValidationStatus": "Unknown",
- "ProblemDetails": {
- "title": "Bad Request",
- "status": 400,
- "detail": "Missing required field 'address'",
- "instance": "/api/v1/physical-post/letters",
- "traceId": "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00"
}
}
], - "Failed": [
- {
- "Id": "064a5f0e-0b0e-4e1e-8e1e-0e0e0e0e0e0e",
- "PmsSpecificId": "064a5f0e-0b0e-4e1e-8e1e-0e0e0e0e0e0e",
- "AddressValidationStatus": "Unknown",
- "ProblemDetails": {
- "title": "Bad Request",
- "status": 400,
- "detail": "Missing required field 'address'",
- "instance": "/api/v1/physical-post/letters",
- "traceId": "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00"
}
}
]
}
Gets a list of letters
SiteSlug required | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ The Slipstream slug that uniquely identifies a physical practice Example: s8n6EzC |
The letter details for this site
Malformed Request (ProblemDetails)
Unauthorized - Provide proof of identity (ProblemDetails)
Forbidden - Insufficient permissions (ProblemDetails)
Not Found - Could not find a matching entity (ProblemDetails)
Unprocessable - Request was well formed but could not be actioned (ProblemDetails)
Too many requests - Chill out (ProblemDetails)
User Error (ProblemDetails)
Server Error (ProblemDetails)
{- "Items": [
- {
- "Express": false,
- "DoubleSided": false,
- "Color": false,
- "LetterId": "string",
- "RecordId": "string",
- "PmsSpecificId": "string",
- "Addressee": {
- "PmsSpecificId": "1234567890abcdef1234567890abcdef",
- "GivenName": "John",
- "MiddleName": "Danger Blanket",
- "FamilyName": "Smith",
- "FullName": "Dr John Smith III"
}, - "Address": {
- "AddressLine1": "123 Main St",
- "AddressLine2": "Apt 4",
- "Locality": "San Francisco",
- "Region": "CA",
- "PostalCode": "94107",
- "Country": "USA"
}, - "Pdf": {
- "Id": "12345678-1234-1234-1234-1234567890ab",
- "Expiry": "2021-01-01T00:00:00Z",
- "RequestHeaders": {
- "X-API-KEY": "1234567890abcdef1234567890abcdef",
- "user-agent": "slipstream/1.0.0",
- "x-practice-site": "dentallyuk34554"
}
}, - "Created": "2024-10-24T14:30:15+02:00",
- "ScheduledSendDate": "2024-10-24T14:30:15+02:00",
- "Sent": "2024-10-24T14:30:15+02:00",
- "State": "Sent",
- "StateDetails": "The letter was sent to the postal provider",
- "Description": "A4 Letter [BlackAndWhite, Standard Delivery, Sent]",
- "History": [
- {
- "Timestamp": "2024-10-24T14:30:15+02:00",
- "Description": "The letter was sent to the postal provider",
- "Status": "Unknown"
}
]
}
], - "NextPageToken": "eyJ0eXAiOi"
}
Get the details of a letter
SiteSlug required | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ The Slipstream slug that uniquely identifies a physical practice Example: s8n6EzC |
LetterId required | string <uuid> The unique identifier (GUID) of the letter in slipstream Example: 44088399-d916-4de5-9f0a-dca7b3d07df2 |
The letter details
Malformed Request (ProblemDetails)
Unauthorized - Provide proof of identity (ProblemDetails)
Forbidden - Insufficient permissions (ProblemDetails)
Not Found - Could not find a matching entity (ProblemDetails)
Unprocessable - Request was well formed but could not be actioned (ProblemDetails)
Too many requests - Chill out (ProblemDetails)
User Error (ProblemDetails)
Server Error (ProblemDetails)
{- "Express": false,
- "DoubleSided": false,
- "Color": false,
- "LetterId": "string",
- "RecordId": "string",
- "PmsSpecificId": "string",
- "Addressee": {
- "PmsSpecificId": "1234567890abcdef1234567890abcdef",
- "GivenName": "John",
- "MiddleName": "Danger Blanket",
- "FamilyName": "Smith",
- "FullName": "Dr John Smith III"
}, - "Address": {
- "AddressLine1": "123 Main St",
- "AddressLine2": "Apt 4",
- "Locality": "San Francisco",
- "Region": "CA",
- "PostalCode": "94107",
- "Country": "USA"
}, - "Pdf": {
- "Id": "12345678-1234-1234-1234-1234567890ab",
- "Expiry": "2021-01-01T00:00:00Z",
- "RequestHeaders": {
- "X-API-KEY": "1234567890abcdef1234567890abcdef",
- "user-agent": "slipstream/1.0.0",
- "x-practice-site": "dentallyuk34554"
}
}, - "Created": "2024-10-24T14:30:15+02:00",
- "ScheduledSendDate": "2024-10-24T14:30:15+02:00",
- "Sent": "2024-10-24T14:30:15+02:00",
- "State": "Sent",
- "StateDetails": "The letter was sent to the postal provider",
- "Description": "A4 Letter [BlackAndWhite, Standard Delivery, Sent]",
- "History": [
- {
- "Timestamp": "2024-10-24T14:30:15+02:00",
- "Description": "The letter was sent to the postal provider",
- "Status": "Unknown"
}
]
}