From bce078ae6ba5deaca1fc038a283ddaf0a2640e2d Mon Sep 17 00:00:00 2001 From: Angel Pastor Date: Mon, 20 Oct 2025 11:41:51 +0100 Subject: [PATCH 1/2] CCM-12610: Update the retryCount documentation --- specification/documentation/CreateMessageBatch.md | 2 +- specification/documentation/GetMessage.md | 2 +- specification/snippets/RetryCount.yaml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/documentation/CreateMessageBatch.md b/specification/documentation/CreateMessageBatch.md index e4217ddf7..614933195 100644 --- a/specification/documentation/CreateMessageBatch.md +++ b/specification/documentation/CreateMessageBatch.md @@ -17,7 +17,7 @@ The per message reference (`messageReference`) needs to be unique within the mes You may be required to send through specific personalisation fields based upon the routing plan (`routingPlanId`). These will have been setup during your [onboarding](#overview--onboarding) process. -These are not validated when we store your message batch, but will be validated when we attempt to send the messages according to the routing plan. If there are values missing from this then the messages will fail to send. +These are validated according to the routing plan when we store your message batch. If there are missing values then the entire batch will be rejected with a CM_INVALID_VALUE code. The detail and source fields will provide further information about the error. ### Sandbox diff --git a/specification/documentation/GetMessage.md b/specification/documentation/GetMessage.md index c0b97f44d..3dd2ba3ca 100644 --- a/specification/documentation/GetMessage.md +++ b/specification/documentation/GetMessage.md @@ -24,7 +24,7 @@ Key values that are returned for each of these channels are: * `channelStatusDescription` - the channel status description * `channelFailureReasonCode` - the channel failed reason code * `supplierStatus` - the status provided by the supplier for this channel -* `retryCount` - the number of times we have attempted delivery +* `retryCount` - the number of times we have attempted delivery, only returned if sending is retried one or more times. * `timestamps` - timestamps of key events * `routingPlan` - the routing plan that was used to generate the channel diff --git a/specification/snippets/RetryCount.yaml b/specification/snippets/RetryCount.yaml index 01ea316d1..599015003 100644 --- a/specification/snippets/RetryCount.yaml +++ b/specification/snippets/RetryCount.yaml @@ -1,3 +1,3 @@ type: integer -description: Contains the number of times that we have attempted to send this message to this channel. +description: Contains the number of times that we have attempted to send this message to this channel. Only returned if sending is retried one or more times. example: 1 \ No newline at end of file From 15f5b8ddee8d65fc8dcc77da542589f1f5b53bf8 Mon Sep 17 00:00:00 2001 From: Angel Pastor <88673423+nhsd-angel-pastor@users.noreply.github.com> Date: Wed, 22 Oct 2025 10:18:09 +0100 Subject: [PATCH 2/2] Update specification/documentation/CreateMessageBatch.md Co-authored-by: Tom D'Roza <83403414+tdroza-nhs@users.noreply.github.com> --- specification/documentation/CreateMessageBatch.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/documentation/CreateMessageBatch.md b/specification/documentation/CreateMessageBatch.md index 614933195..c0b9a0c0d 100644 --- a/specification/documentation/CreateMessageBatch.md +++ b/specification/documentation/CreateMessageBatch.md @@ -17,7 +17,7 @@ The per message reference (`messageReference`) needs to be unique within the mes You may be required to send through specific personalisation fields based upon the routing plan (`routingPlanId`). These will have been setup during your [onboarding](#overview--onboarding) process. -These are validated according to the routing plan when we store your message batch. If there are missing values then the entire batch will be rejected with a CM_INVALID_VALUE code. The detail and source fields will provide further information about the error. +These are validated according to the routing plan when we store your message batch. If there are missing values then the entire batch will be rejected with a `CM_INVALID_VALUE` code. The detail and source fields will provide further information about the error. ### Sandbox