SyncLeadRequest
5 properties18 including nested1 operation uses this
Properties
action string Type of sync operation to perform. Defaults to createOrUpdate if unset
Values createOnly updateOnly createOrUpdate createDuplicate
asyncProcessing boolean If set to true, the call will return immediately
input array of Lead required
List of leads for input
Model Lead
id integer (int32) Unique integer id of a lead record
membership ProgramMembership
Membership data for the parent program. Only returned via Get Leads By Program Id
Model ProgramMembership
acquiredBy boolean Whether the lead was acquired by the parent program
isExhausted boolean Whether the lead is currently exhausted in the stream, if applicable
membershipDate string required Date the lead first became a member of the program
nurtureCadence string Cadence of the parent stream if applicable
progressionStatus string required Program status of the lead in the parent program
reachedSuccess boolean Whether the lead is in a success-status in the parent program
stream string Stream that the lead is a member of, if the parent program is an engagement program
reason Reason
Reason object describing why an operation did not succeed for a record
Model Reason
code string required Integer code of the reason
message string required Message describing the reason for the status of the operation
status string Status of the operation performed on the record
lookupField string Field to deduplicate on. The field must be present in each lead record of the input. Defaults to email if unset
partitionName string Name of the partition to operate on, if applicable. Should be set whenever possible, when interacting with an instance where partitions are enabled.
Referenced models
Used by
Leads
POSTSync LeadsGenerated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.