Back to MarketoSync Leads
Syncs a list of leads to the target instance. Required Permissions: Read-Write Lead
Input
type: object
properties:
data:
required:
- input
type: object
properties:
action:
type: string
description: >-
Type of sync operation to perform. Defaults to createOrUpdate if
unset
enum:
- createOnly
- updateOnly
- createOrUpdate
- createDuplicate
asyncProcessing:
type: boolean
description: If set to true, the call will return immediately
example: false
input:
type: array
description: List of leads for input
items:
type: object
description: >-
Lead record. Always contains id, but may have any number of other
fields, depending on the fields available in the target instance.
properties:
id:
type: integer
description: Unique integer id of a lead record
format: int32
membership:
required:
- membershipDate
- progressionStatus
type: object
properties:
acquiredBy:
type: boolean
description: Whether the lead was acquired by the parent program
example: false
isExhausted:
type: boolean
description: >-
Whether the lead is currently exhausted in the stream, if
applicable
example: false
membershipDate:
type: string
description: Date the lead first became a member of the program
nurtureCadence:
type: string
description: Cadence of the parent stream if applicable
progressionStatus:
type: string
description: Program status of the lead in the parent program
reachedSuccess:
type: boolean
description: >-
Whether the lead is in a success-status in the parent
program
example: false
stream:
type: string
description: >-
Stream that the lead is a member of, if the parent program
is an engagement program
reason:
required:
- code
- message
type: object
properties:
code:
type: string
description: Integer code of the reason
message:
type: string
description: >-
Message describing the reason for the status of the
operation
status:
type: string
description: Status of the operation performed on the record
lookupField:
type: string
description: >-
Field to deduplicate on. The field must be present in each lead
record of the input. Defaults to email if unset
partitionName:
type: string
description: >-
Name of the partition to operate on, if applicable. Should be set
whenever possible, when interacting with an instance where partitions
are enabled.
title: Data
Output
required:
- errors
- requestId
- result
- success
- warnings
type: object
properties:
errors:
type: array
description: Array of errors that occurred if the request was unsuccessful
items:
required:
- code
- message
type: object
properties:
code:
type: string
description: >-
Error code of the error. See full list of error codes <a
href="https://developers.marketo.com/rest-api/error-codes/">here</a>
message:
type: string
description: Message describing the cause of the error
moreResult:
type: boolean
description: Boolean indicating if there are more results in subsequent pages
example: false
nextPageToken:
type: string
description: Paging token given if the result set exceeded the allowed batch size
requestId:
type: string
description: Id of the request made
result:
type: array
description: Array of results for individual records in the operation, may be empty
items:
type: object
description: >-
Lead record. Always contains id, but may have any number of other
fields, depending on the fields available in the target instance.
properties:
id:
type: integer
description: Unique integer id of a lead record
format: int32
membership:
required:
- membershipDate
- progressionStatus
type: object
properties:
acquiredBy:
type: boolean
description: Whether the lead was acquired by the parent program
example: false
isExhausted:
type: boolean
description: >-
Whether the lead is currently exhausted in the stream, if
applicable
example: false
membershipDate:
type: string
description: Date the lead first became a member of the program
nurtureCadence:
type: string
description: Cadence of the parent stream if applicable
progressionStatus:
type: string
description: Program status of the lead in the parent program
reachedSuccess:
type: boolean
description: Whether the lead is in a success-status in the parent program
example: false
stream:
type: string
description: >-
Stream that the lead is a member of, if the parent program is an
engagement program
reason:
required:
- code
- message
type: object
properties:
code:
type: string
description: Integer code of the reason
message:
type: string
description: Message describing the reason for the status of the operation
status:
type: string
description: Status of the operation performed on the record
success:
type: boolean
description: Whether the request succeeded
example: false
warnings:
type: array
description: Array of warnings given for the operation
items:
required:
- code
- message
type: object
properties:
code:
type: integer
description: Integer code of the warning
format: int32
message:
type: string
description: Message describing the warning