Add Person to Flow

Creates or updates a person and adds it to Flow

post/communication/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 person will be added to

Query parameters

phonestring

Person's phone number

emailstring

Person's email address

externalIdstring

Unique ID for the person from an external system

Request body

flowVariablesobject nullable

Example request

{
  "personData": {
    "externalId": "1",
    "firstName": "Jane",
    "lastName": "Smith",
    "address": "67 Farringdon Road",
    "city": "London",
    "country": "United Kingdom",
    "gender": "FEMALE",
    "birthDate": "1966-01-15",
    "middleName": "Janie",
    "profilePicture": "http://profile.com",
    "tags": [
      "VIP Customers",
      "New Customers"
    ],
    "customAttributes": {
      "Contract Expiry": "2018-06-01",
      "Company": "Acme"
    },
    "contactInformation": {
      "phone": [
        {
          "number": "41793026727"
        },
        {
          "number": "41793026728"
        }
      ],
      "email": [
        {
          "address": "jane@acme.com"
        },
        {
          "address": "janesmith@acme.com"
        }
      ]
    }
  },
  "flowVariables": {
    "orderDate": "2021-09-01",
    "orderDetails": "Extended Weight, Discount",
    "orderNumber": 1234567
  }
}

Response

Changes

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