Back to MarketoGet Smart Campaigns by Lead Id
Query smart campaign membership for one lead. Required Permissions: Read-Only Asset
Input
type: object
properties:
parameters:
type: object
properties:
leadId:
type: integer
format: int64
description: The Marketo lead id
nextPageToken:
type: string
description: >-
A token will be returned by this endpoint if the result set is greater
than the batch size and can be passed in a subsequent call through
this parameter. See Paging Tokens for more info.
batchSize:
type: integer
format: int32
description: Maximum number of records to return. Maximum and default is 300.
earliestUpdatedAt:
type: string
description: >-
Exclude smart campaigns prior to this date. Must be valid ISO-8601
string. See <a
href="http://developers.marketo.com/rest-api/lead-database/fields/field-types/">Datetime</a>
field type description.
latestUpdatedAt:
type: string
description: >-
Exclude smart campaigns after this date. Must be valid ISO-8601
string. See <a
href="http://developers.marketo.com/rest-api/lead-database/fields/field-types/">Datetime</a>
field type description.
required:
- leadId
title: Parameters
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:
required:
- createdAt
- smartCampaignId
- updatedAt
type: object
properties:
createdAt:
type: string
description: Datetime when the smart campaign was created
smartCampaignId:
type: integer
description: Unique integer id of the smart campaign
format: int32
updatedAt:
type: string
description: Datetime when the smart campaign was most recently updated
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