Skip to main content
POST
cURL

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