customer-engagement
moments
flow

Add participants to flow

Use this endpoint to add participants to a flow, accommodating anywhere from 1 to 1000 persons. When participants are added, their profiles in People are automatically created, updated or merged based on the identifiers provided.<br> If identifiers are unique, a new profile is created.<br> If identifiers match an existing profile, then that profile is updated.<br> If identifiers refer to multiple existing profiles or are not unique within the request, profiles are merged.<br> To prevent unwanted merges, ensure each participant's identifiers (<code>identifyBy</code>, <code>externalId</code> and <code>contactInformation</code>) are unique.<br> Optional parameter <code>skipMergeDuplicates</code> might be used to prevent merging to single person. Participant won't be added to campaign in this case.

post/moments/1/flows/{campaignId}/participants

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Path parameters

campaignIdinteger required

Unique identifier of the flow that participant will be added to.

Request body

notifyUrlstring nullable

The URL on your callback server on which a report of operation results will be sent.

callbackDatastring nullable

Additional data will be passed in the request to your callback server along with the operation results report.

skipMergeDuplicatesboolean nullable

If identifier refer to multiple existing profiles - set to true to prevent merging to single person. Participant won't be added to campaign.

Response

OK

operationIdstring required

Unique identifier of the operation.

Example response

{
  "operationId": "03f2d474-0508-46bf-9f3d-d8e2c28adaea"
}

Changes

No recorded changes to this operation across all 1 revision of this API.