From 2f73ef46053becd67e24864431f400db75e3587c Mon Sep 17 00:00:00 2001 From: aidanlesh-sap Date: Wed, 2 Oct 2024 15:57:40 -0400 Subject: [PATCH] Add comprehensive description to outbound message sending 400 SC-4051 --- openapi/sms/v1/partner-service.yaml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/openapi/sms/v1/partner-service.yaml b/openapi/sms/v1/partner-service.yaml index 5316ae5..92e4820 100644 --- a/openapi/sms/v1/partner-service.yaml +++ b/openapi/sms/v1/partner-service.yaml @@ -141,7 +141,14 @@ paths: '202': $ref: './common.yaml#/components/responses/AcceptedResponse' '400': - description: Returns error type and error context globally, for all messages, or per message + description: | + Returns error type and error context globally, for all messages, or per message. + + Use the OutboundMessageBatchGlobalError schema if there is an issue with the payload as a whole, and use the OutboundMessageBatchMessageSpecificError response schema if any of the messages are invalid. + + No messages should be sent or processed if the payload is invalid in any way, even if there are some valid messages among the invalid ones. + + Upon recieving a OutboundMessageBatchMessageSpecificError response, the Emarsys SMS Service will treat all of the messages with errors as failed and will retry any messages that did not have errors. content: application/json: schema: