Create or update a profile
https://email.growthdept.ai/api/profile-importFinds the profile by id, email, phone number or external id and updates it, or creates it. Identifiers that belong to two different profiles answer 409 duplicate_profile.
Ask for subscriptions, predictive_analytics, hashed_email and hashed_phone_number with additional-fields[profile]; they are left out unless you do.
The request body can be up to 5 MB.
Rate limits
Scopes
profiles:write
Operation id
create_or_update_profile The same operation as in Klaviyo's API. OpenAPI document
Query parameters
Pick values to add them to the request:
Pick values to add them to the request:
Body
Send application/vnd.api+json or application/json.
object
dataobjectrequired
data: 5 fields
typestringrequired
profileidstring
attributesobjectrequired
attributes: 11 fields
emailstringcan be null
phone_numberstringcan be null
external_idstringcan be null
first_namestringcan be null
last_namestringcan be null
organizationstringcan be null
localestringcan be null
titlestringcan be null
imagestringcan be null
locationobject
location: 10 fields
address1stringcan be null
address2stringcan be null
citystringcan be null
countrystringcan be null
latitudestring or numbercan be null
longitudestring or numbercan be null
regionstringcan be null
zipstringcan be null
timezonestringcan be null
ipstringcan be null
propertiesobject
relationshipsobject
metaobject
meta: 2 fields
patch_propertiesobject
patch_properties: 3 fields
appendobject
unappendobject
unsetobject
patch_identifiersobject
patch_identifiers: 2 fields
appendobject
unappendobject
Edit the example. The code samples use what you type here.
Headers
stringrequireddefault 2026-10-15
API revision, YYYY-MM-DD. This server implements 2026-10-15.
Responses
200Success
Response body
object
dataobjectrequired
data: 5 fields
typestringrequired
profileidstringcan be null
attributesobjectrequired
attributes: 18 fields
emailstringcan be null
phone_numberstringcan be null
external_idstringcan be null
first_namestringcan be null
last_namestringcan be null
organizationstringcan be null
localestringcan be null
titlestringcan be null
imagestringcan be null
createdstring (date-time)can be null
updatedstring (date-time)can be null
last_event_datestring (date-time)can be null
locationobjectcan be null
location: 10 fields
address1stringcan be null
address2stringcan be null
citystringcan be null
countrystringcan be null
latitudeone ofcan be null
One option: string
No fields.
One option: number
No fields.
longitudeone ofcan be null
One option: string
No fields.
One option: number
No fields.
regionstringcan be null
zipstringcan be null
timezonestringcan be null
ipstringcan be null
propertiesobjectcan be null
subscriptionsobjectcan be null
subscriptions: 4 fields
emailobjectcan be null
email: 3 fields
marketingobjectcan be null
marketing: 10 fields
can_receive_email_marketingbooleanrequired
consentstringrequired
consent_timestampstring (date-time)can be null
last_updatedstring (date-time)can be null
methodstringcan be null
method_detailstringcan be null
custom_method_detailstringcan be null
double_optinbooleancan be null
suppressionarray of objectscan be null
suppression: 2 fields
reasonstringrequired
HARD_BOUNCEINVALID_EMAILSPAM_COMPLAINTUNSUBSCRIBEUSER_SUPPRESSEDtimestampstring (date-time)required
list_suppressionsarray of objectscan be null
list_suppressions: 3 fields
list_idstringrequired
reasonstringrequired
timestampstring (date-time)required
open_trackingobjectcan be null
open_tracking: 7 fields
consentstringrequired
consent_timestampstring (date-time)can be null
last_updatedstring (date-time)can be null
created_timestampstring (date-time)can be null
metadataobjectcan be null
can_receivebooleanrequired
valid_untilstring (date-time)can be null
click_trackingobjectcan be null
click_tracking: 7 fields
consentstringrequired
consent_timestampstring (date-time)can be null
last_updatedstring (date-time)can be null
created_timestampstring (date-time)can be null
metadataobjectcan be null
can_receivebooleanrequired
valid_untilstring (date-time)can be null
smsobjectcan be null
sms: 2 fields
marketingobjectcan be null
marketing: 6 fields
can_receive_sms_marketingbooleanrequired
consentstringrequired
consent_timestampstring (date-time)can be null
methodstringcan be null
method_detailstringcan be null
last_updatedstring (date-time)can be null
transactionalobjectcan be null
transactional: 6 fields
can_receive_sms_transactionalbooleanrequired
consentstringrequired
consent_timestampstring (date-time)can be null
methodstringcan be null
method_detailstringcan be null
last_updatedstring (date-time)can be null
mobile_pushobjectcan be null
mobile_push: 1 field
marketingobjectcan be null
marketing: 3 fields
can_receive_push_marketingbooleanrequired
consentstringrequired
consent_timestampstring (date-time)can be null
whatsappobjectcan be null
whatsapp: 3 fields
marketingobjectcan be null
marketing: 8 fields
consentstringrequired
consent_timestampstring (date-time)can be null
last_updatedstring (date-time)can be null
created_timestampstring (date-time)can be null
metadataobjectcan be null
can_receivebooleanrequired
valid_untilstring (date-time)can be null
phone_numberstringcan be null
transactionalobjectcan be null
transactional: 8 fields
consentstringrequired
consent_timestampstring (date-time)can be null
last_updatedstring (date-time)can be null
created_timestampstring (date-time)can be null
metadataobjectcan be null
can_receivebooleanrequired
valid_untilstring (date-time)can be null
phone_numberstringcan be null
conversationalobjectcan be null
conversational: 8 fields
consentstringrequired
consent_timestampstring (date-time)can be null
last_updatedstring (date-time)can be null
created_timestampstring (date-time)can be null
metadataobjectcan be null
can_receivebooleanrequired
valid_untilstring (date-time)can be null
phone_numberstringcan be null
predictive_analyticsobjectcan be null
predictive_analytics: 10 fields
historic_clvnumbercan be null
predicted_clvnumbercan be null
total_clvnumbercan be null
historic_number_of_ordersnumbercan be null
predicted_number_of_ordersnumbercan be null
average_days_between_ordersnumbercan be null
average_order_valuenumbercan be null
churn_probabilitynumbercan be null
expected_date_of_next_orderstring (date-time)can be null
ranked_channel_affinityarray of stringscan be null
hashed_emailstringcan be null
hashed_phone_numberstringcan be null
relationshipsobject
relationships: 3 fields
listsobject
lists: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
listidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
segmentsobject
segments: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
segmentidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
push-tokensobject
push-tokens: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
push-tokenidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
linksobjectrequired
links: 1 field
selfstring (uri)required
linksobject
links: 1 field
selfstring (uri)required
metaobject
4XXClient error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject
See status codes for each code.
5XXServer error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject