Skip to content

Commit 9488f69

Browse files
authored
Add forbidPartialDelivery option to the Narrowcast Limit Object (#114)
## Add forbidPartialDelivery option to the Narrowcast Limit Object We add a new `forbidPartialDelivery` option to the Narrowcast Limit Object. When set to true, this option prevents messages from being delivered to only a subset of the target audience. If partial delivery occurs, the narrowcast request will succeed but fail asynchronously. You can verify whether the message delivery was canceled by checking the narrowcast message progress. This property can only be set to true when upToRemainingQuota is also true. For more details, see the https://developers.line.biz/en/news/2025/10/21/narrowcast-message-update/. ### Example: ```json { "max": 100, "upToRemainingQuota": true, "forbidPartialDelivery": true } ```
1 parent 8025f6c commit 9488f69

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

messaging-api.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2837,6 +2837,15 @@ components:
28372837
If true, the message will be sent within the maximum number of deliverable messages. The default value is `false`.
28382838
28392839
Targets will be selected at random.
2840+
forbidPartialDelivery:
2841+
type: boolean
2842+
default: false
2843+
description: |+
2844+
This option prevents messages from being delivered to only a subset of the target audience.
2845+
If true, the narrowcast request success but fails asynchronously.
2846+
You can check whether message delivery was canceled by retrieving the narrowcast message progress.
2847+
2848+
This property can be set to true only if upToRemainingQuota is set to true.
28402849
NarrowcastProgressResponse:
28412850
externalDocs:
28422851
url: https://developers.line.biz/en/reference/messaging-api/#get-narrowcast-progress-status
@@ -2885,6 +2894,7 @@ components:
28852894
`2`: An error occurred because there weren't enough recipients.
28862895
`3`: A conflict error of requests occurs because a request that has already been accepted is retried.
28872896
`4`: An audience of less than 50 recipients is included as a condition of sending.
2897+
`5`: Message delivery has been canceled to prevent messages from being delivered only to a subset of the target audience.
28882898
acceptedTime:
28892899
type: string
28902900
format: date-time

0 commit comments

Comments
 (0)