Get Smart Campaigns by Lead Id

GET /rest/v1/leads/{leadId}/smartCampaignMembership.json

Query smart campaign membership for one lead.

Operation ID: getSmartCampaignMembershipUsingGET
Permissions: Read-Only Asset
Request format: application/json
Returns: ResponseOfSmartCampaigns

Parameters

Path 1

leadId integer (int64) required

The Marketo lead id

Query 4

nextPageToken string

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 integer (int32)

Maximum number of records to return. Maximum and default is 300.

earliestUpdatedAt string

Exclude smart campaigns prior to this date. Must be valid ISO-8601 string. See Datetime field type description.

latestUpdatedAt string

Exclude smart campaigns after this date. Must be valid ISO-8601 string. See Datetime field type description.

Responses

200 OK ResponseOfSmartCampaigns

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 SmartCampaign required

Array of results for individual records in the operation, may be empty

Model SmartCampaign

createdAt string required

Datetime when the smart campaign was created

smartCampaignId integer (int32) required

Unique integer id of the smart campaign

updatedAt string required

Datetime when the smart campaign was most recently updated

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

Generated example

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "example-token",
  "requestId": "123",
  "result": [
    {
      "createdAt": "string",
      "smartCampaignId": 123,
      "updatedAt": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 123,
      "message": "string"
    }
  ]
}

Referenced models

Generated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.