Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions specification/mesh-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1942,6 +1942,38 @@ paths:
example: |-
message content....
any content type is acceptable but use application/octet-stream if you want a single default
post:
tags:
- Outbox
summary: Carbon Copy (CC) a message
description: |-
## Overview
CC creates an additional copy of a message and delivers it to another mailbox. The copied message will produce a new message with a different MESH message ID. The original recipient still receives the message. CC is configured by the MESH service team, to learn more about CC see our [Service Page](https://digital.nhs.uk/services/message-exchange-for-social-care-and-health-mesh#mesh-cc-and-redirect).

### To CC a message:

The required field is:
- cc_to_mailbox_id (target mailbox)

Plus at least one of:
- cc_if_sender
- cc_if_recipient
- workflow_id

post:
tags:
- Outbox
summary: Redirect a message
description: |-
## Overview
Redirect replaces the original recipient with a different mailbox. The original recipient does not receive the message. Redirects are configured by the MESH service team, to learn more about redirects see our [Service Page](https://digital.nhs.uk/services/message-exchange-for-social-care-and-health-mesh#mesh-cc-and-redirect).

### To redirect a message:

The required fields are:
- redirect_to_mailbox_id (replacing mailbox)
- redirect_if_recipient (original intended recipient)

/messageexchange/{mailbox_id}/outbox/tracking:
get:
tags:
Expand Down
Loading