Skip to main content
POST
The API can trigger campaigns for app push, web push, Kakao AlimTalk, Kakao Friendtalk, Kakao Brand Message, text messages, email, and LINE according to the project’s channel configuration. Friendtalk is a legacy channel.
Recipient types and personalizationAn unsupported recipient type for the selected channel returns 400 Bad Request.Use user-id to look up user data for personalization. With other recipient types, Notifly uses the information in the request. For example, in Hello {{ user["name"] }}, the user name is empty and the recipient sees Hello.All recipient types support event parameters.
How Notifly handles duplicatesNotifly sends once per unique device token for app push and web push. It sends once per unique phone number for Kakao AlimTalk, Kakao Friendtalk, Kakao Brand Message, and text messages. Email uses the email address, and LINE uses the LINE user ID.
Invalid recipients in a 400 responseWhen recipient validation fails, the 400 response includes errorDetails.
  • A 400 response contains code, success, and error. Only recipient validation failures add errorDetails. Other 400 errors, such as invalid parameters or an inactive campaign, omit it.
  • A user-id recipient is invalid if the user exists in Notifly and lacks the required contact information. Notifly skips unknown user IDs.
  • When partialSend is false or omitted, one invalid recipient causes the entire request to fail with 400 and no messages are sent.
  • To retry, inspect errorDetails.invalidRecipients and remove the invalid recipients from the request.
Partial sendsSet partialSend to true to send to valid recipients even if other recipients lack a phone number or email address.
  • With partialSend: false (the default), any invalid recipient causes the request to fail with 400 and sends no messages.
  • With partialSend: true, Notifly sends to valid recipients and lists the invalid recipients in the response. It returns 200 even when every recipient is invalid.
Example response with partialSend: true and two invalid recipients.
Channels that support partial sends are kakao-alimtalk, kakao-friendtalk, kakao-brand-message, text-message, and email.
This contact information check applies to recipients specified with user-id. It does not apply when you specify the recipient directly with type: "phone-number" or type: "email".

Authorizations

Authorization
string
header
required

Pass the token issued by POST /authenticate as a bearer token.

Path Parameters

projectId
string
required

Project ID.

campaignId
string
required

Campaign ID from the console.

Body

application/json
recipients
object[]
required

List of recipients. Up to 1,000 entries.

partialSend
boolean
default:false

When true, send to valid recipients even if some recipients lack required phone numbers or email addresses. The response lists any invalid recipients. When false or omitted, an invalid recipient causes the entire request to fail.

Response

The campaign was triggered. If partialSend is true and some recipients are invalid, the response includes errorDetails.

code
integer
success
boolean
error
string | null
errorDetails
object

Included when partialSend is true and one or more recipients are invalid.