Update a source mapping
https://email.growthdept.ai/api/source-mappings/{id}Replaces the property mappings and the relationship mappings that are given; leaves the others.
The request body can be up to 5 MB.
Rate limits
Scopes
custom-objects:write
Operation id
update_source_mapping The same operation as in Klaviyo's API. OpenAPI document
Path parameters
stringrequired
Query parameters
Pick values to add them to the request:
Body
Send application/vnd.api+json or application/json.
object
dataobjectrequired
data: 3 fields
typestringrequired
source-mappingidstringrequired
attributesobjectrequired
attributes: 2 fields
property_mappingsarray of objects
relationship_mappingsarray of objects
relationship_mappings: 3 fields
relationship_idstringrequired
typestringrequired
simplesourceone ofrequired
One option: object
source_idstringrequired
typestringrequired
custom-objectid_pathstringrequired
related_id_pathstringrequired
update_strategystring
One option: object
source_idstringrequired
typestringrequired
profileid_pathstringrequired
related_id_pathsarray of objectsrequired
related_id_paths: 2 fields
identifier_typestringrequired
anonymousemailexternal-idklaviyo-idphonepathstringrequired
update_strategystring
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: 4 fields
typestringrequired
source-mappingidstringrequired
attributesobjectrequired
attributes: 2 fields
property_mappingsarray of objectsrequired
One option: ConstantPropertyMapping
idintegerrequired
typestringrequired
constantvalueone ofrequired
One option: integer
No fields.
One option: number
No fields.
One option: string
No fields.
One option: boolean
No fields.
One option: SimplePropertyMapping
idintegerrequired
typestringrequired
simplesourceobjectrequired
source: 3 fields
source_idstringrequired
id_pathstringrequired
data_pathstringrequired
relationship_mappingsarray of objectsrequired
relationship_mappings: 3 fields
relationship_idstringrequired
typestringrequired
simplesourceone ofrequired
One option: CustomObjectRelationshipSource
source_idstringrequired
typestringrequired
custom-objectid_pathstringrequired
related_id_pathstringrequired
update_strategystringcan be null
additivereplace_from_origin
One option: ProfileRelationshipSource
source_idstringrequired
typestringrequired
profileid_pathstringrequired
related_id_pathsarray of objectsrequired
related_id_paths: 2 fields
identifier_typestringrequired
anonymousemailexternal-idklaviyo-idphonepathstringrequired
update_strategystringcan be null
additivereplace_from_origin
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