Skip to main content
POST
/
consumers
/
batch
cURL
curl --request POST \
  --url https://admin.fanfare.io/api/consumers/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "consumers": [
    {
      "emailVerified": true,
      "phoneVerified": true,
      "activityRank": 123,
      "activityScore": 123,
      "activityScoreUpdatedAt": "<string>",
      "aov": "<string>",
      "email": "[email protected]",
      "engagedCount": 123,
      "fullName": "<string>",
      "lastEngagedAt": "<string>",
      "lastGeoAt": "<string>",
      "lastGeoCity": "<string>",
      "lastGeoCoordinates": {
        "latitude": 123,
        "longitude": 123
      },
      "lastGeoCountry": "<string>",
      "lastGeoPostalCode": "<string>",
      "lastGeoRegion": "<string>",
      "lastGeoSource": "<string>",
      "lastGeoTimezone": "<string>",
      "lastLoginAt": "<string>",
      "lastOrderAt": "<string>",
      "lastReturnAt": "<string>",
      "loyaltyBalance": 123,
      "loyaltyLastActivityAt": "<string>",
      "loyaltyLifetimePoints": 123,
      "ltv": "<string>",
      "metadata": {},
      "monetaryRank": 123,
      "monetaryScore": 123,
      "monetaryScoreUpdatedAt": "<string>",
      "phone": "<string>",
      "purchaseFrequencyRank": 123,
      "purchaseFrequencyScore": 123,
      "purchaseFrequencyScoreUpdatedAt": "<string>",
      "smsOptOut": true,
      "totalEngagements": 123,
      "totalMessages": 123,
      "totalOrders": 123,
      "totalReturns": 123,
      "verificationCode": "<string>",
      "verificationCodeExpiresAt": "<string>"
    }
  ]
}
'
[
  {
    "archived": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "emailVerified": true,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "phoneVerified": true,
    "activityRank": 0,
    "activityScore": 0,
    "activityScoreUpdatedAt": "2023-11-07T05:31:56Z",
    "aov": "0",
    "email": "[email protected]",
    "engagedCount": 0,
    "fullName": "<string>",
    "lastEngagedAt": "2023-11-07T05:31:56Z",
    "lastGeoAt": "2023-11-07T05:31:56Z",
    "lastGeoCity": "<string>",
    "lastGeoCoordinates": {
      "latitude": 123,
      "longitude": 123
    },
    "lastGeoCountry": "<string>",
    "lastGeoPostalCode": "<string>",
    "lastGeoRegion": "<string>",
    "lastGeoSource": "<string>",
    "lastGeoTimezone": "<string>",
    "lastLoginAt": "2023-11-07T05:31:56Z",
    "lastOrderAt": "2023-11-07T05:31:56Z",
    "lastReturnAt": "2023-11-07T05:31:56Z",
    "loyaltyBalance": 0,
    "loyaltyLastActivityAt": "2023-11-07T05:31:56Z",
    "loyaltyLifetimePoints": 0,
    "ltv": "0",
    "metadata": {},
    "monetaryRank": 0,
    "monetaryScore": 0,
    "monetaryScoreUpdatedAt": "2023-11-07T05:31:56Z",
    "phone": "<string>",
    "primaryExternalId": "<string>",
    "primaryLastSyncedAt": "2023-11-07T05:31:56Z",
    "primarySourceVendor": "<string>",
    "primarySyncSourceId": "<string>",
    "purchaseFrequencyRank": 0,
    "purchaseFrequencyScore": 0,
    "purchaseFrequencyScoreUpdatedAt": "2023-11-07T05:31:56Z",
    "smsOptOut": false,
    "totalEngagements": 0,
    "totalMessages": 0,
    "totalOrders": 0,
    "totalReturns": 0,
    "updatedAt": "2023-11-07T05:31:56Z",
    "updatedBy": "<string>",
    "verificationCode": "<string>",
    "verificationCodeExpiresAt": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Fanfare secret key. Keep secret credentials on your server.

Body

application/json
​
consumers
object[]
required

Response

Consumers created successfully

​
archived
boolean
required
​
createdAt
string<date-time>
required
​
createdBy
string
required
​
emailVerified
boolean
required
​
id
string<uuid>
required
​
organizationId
string<uuid>
required
​
phoneVerified
boolean
required
​
status
enum<string>
required
Available options:
ACTIVE,
INACTIVE
​
activityRank
integer
default:0
Required range: 0 <= x <= 5
​
activityScore
number
default:0
​
activityScoreUpdatedAt
string<date-time> | null
​
aov
string
default:0
Pattern: ^\d{1,12}(\.\d{1,8})?$
​
email
string<email> | null
​
engagedCount
number
default:0
​
fullName
string | null
​
lastEngagedAt
string<date-time> | null
​
lastGeoAt
string<date-time> | null
​
lastGeoCity
string | null
​
lastGeoCoordinates
object | null
​
lastGeoCountry
string | null
​
lastGeoPostalCode
string | null
​
lastGeoRegion
string | null
​
lastGeoSource
string | null
​
lastGeoTimezone
string | null
​
lastLoginAt
string<date-time> | null
​
lastOrderAt
string<date-time> | null
​
lastReturnAt
string<date-time> | null
​
loyaltyBalance
number
default:0
​
loyaltyLastActivityAt
string<date-time> | null
​
loyaltyLifetimePoints
number
default:0
​
ltv
string
default:0
Pattern: ^\d{1,12}(\.\d{1,8})?$
​
metadata
object | null
​
monetaryRank
integer
default:0
Required range: 0 <= x <= 5
​
monetaryScore
number
default:0
​
monetaryScoreUpdatedAt
string<date-time> | null
​
phone
string | null
​
primaryExternalId
string | null
​
primaryLastSyncedAt
string<date-time> | null
​
primarySourceVendor
string | null
​
primarySyncSourceId
string | null
​
purchaseFrequencyRank
integer
default:0
Required range: 0 <= x <= 5
​
purchaseFrequencyScore
number
default:0
​
purchaseFrequencyScoreUpdatedAt
string<date-time> | null
​
smsOptOut
boolean
default:false
​
totalEngagements
number
default:0
​
totalMessages
number
default:0
​
totalOrders
number
default:0
​
totalReturns
number
default:0
​
updatedAt
string<date-time> | null
​
updatedBy
string | null
​
verificationCode
string | null
​
verificationCodeExpiresAt
string | null