ResponseOfLead
7 properties24 including nested7 operations use this
Properties
errors array of Error required
Array of errors that occurred if the request was unsuccessful
Model Error
code string required Error code of the error. See full list of error codes here
message string required Message describing the cause of the error
moreResult boolean Boolean indicating if there are more results in subsequent pages
nextPageToken string Paging token given if the result set exceeded the allowed batch size
requestId string required Id of the request made
result array of Lead required
Array of results for individual records in the operation, may be empty
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
success boolean required Whether the request succeeded
warnings array of Warning required
Array of warnings given for the operation
Model Warning
code integer (int32) required Integer code of the warning
message string required Message describing the warning
Referenced models
Used by
Leads
POSTDelete LeadsGETGet Lead by IdGETGet Leads by Filter TypeGETGet Leads by Program IdPOSTSync LeadsPOSTUpdate Lead PartitionStatic Lists
GETGet Leads By List IdGenerated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.