Skip to content

Commit 4f2746f

Browse files
authored
Adding CC + redirect to OAS
Added the config that is previously on the service page to the OAS spec to make sure people know that CC and redirect are things if the
1 parent 012883d commit 4f2746f

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

specification/mesh-api.yaml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1942,6 +1942,38 @@ paths:
19421942
example: |-
19431943
message content....
19441944
any content type is acceptable but use application/octet-stream if you want a single default
1945+
post:
1946+
tags:
1947+
- Outbox
1948+
summary: Carbon Copy (CC) a message
1949+
description: |-
1950+
## Overview
1951+
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).
1952+
1953+
### To CC a message:
1954+
1955+
The required field is:
1956+
- cc_to_mailbox_id (target mailbox)
1957+
1958+
Plus at least one of:
1959+
- cc_if_sender
1960+
- cc_if_recipient
1961+
- workflow_id
1962+
1963+
post:
1964+
tags:
1965+
- Outbox
1966+
summary: Redirect a message
1967+
description: |-
1968+
## Overview
1969+
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).
1970+
1971+
### To redirect a message:
1972+
1973+
The required fields are:
1974+
- redirect_to_mailbox_id (replacing mailbox)
1975+
- redirect_if_recipient (original intended recipient)
1976+
19451977
/messageexchange/{mailbox_id}/outbox/tracking:
19461978
get:
19471979
tags:

0 commit comments

Comments
 (0)