/marketo-activities | Type: Application | PCID required: Yes
Tools
marketo-activities_add_custom_activity
Add Custom Activities Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
input | object[] | Yes | — | List of custom activities to insert |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"input": {
"type": "array",
"items": {
"type": "object",
"properties": {
"activityDate": {
"type": "string",
"description": "Datetime of the activity"
},
"activityTypeId": {
"type": "integer",
"format": "int32",
"description": "Id of the activity type"
},
"apiName": {
"type": "string",
"description": "Api Name"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"apiName": {
"type": "string"
},
"name": {
"type": "string",
"description": "Name of the attribute"
},
"value": {
"type": "object",
"description": "Value of the attribute"
}
}
},
"description": "List of secondary attributes"
},
"errors": {
"type": "array",
"items": {
"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"
}
}
},
"description": "Array of errors that occurred if the request was unsuccessful"
},
"id": {
"type": "integer",
"format": "int64",
"description": "Integer id of the activity. For instances which have been migrated to Activity Service, this field may not be present, and should not be treated as unique."
},
"leadId": {
"type": "integer",
"format": "int64",
"description": "Id of the lead associated to the activity"
},
"marketoGUID": {
"type": "string",
"description": "Unique id of the activity (128 character string)"
},
"primaryAttributeValue": {
"type": "string",
"description": "Value of the primary attribute"
},
"status": {
"type": "string",
"enum": [
"created",
"updated",
"deleted",
"skipped",
"added",
"removed"
],
"description": "Status of the operation performed on the record"
}
},
"required": [
"activityDate",
"activityTypeId",
"attributes",
"leadId",
"primaryAttributeValue"
]
},
"description": "List of custom activities to insert"
}
},
"required": [
"PCID",
"input"
]
}
marketo-activities_approve_custom_activity_type
Approve Custom Activity Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
apiName | string | Yes | — | API Name of the activity type |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"apiName": {
"type": "string",
"description": "API Name of the activity type"
}
},
"required": [
"PCID",
"apiName"
]
}
marketo-activities_create_custom_activity_type
Create Custom Activity Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
apiName | string | Yes | — | Api Name |
description | string | No | — | The description value |
filterName | string | Yes | — | Human-readable name of the associated filter |
name | string | Yes | — | Human-readable display name of the activity type |
primaryAttribute | object | Yes | — | Primary Attribute |
triggerName | string | Yes | — | Human-readable name of the associated trigger |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"apiName": {
"type": "string",
"description": "Api Name"
},
"description": {
"type": "string",
"description": "The description value"
},
"filterName": {
"type": "string",
"description": "Human-readable name of the associated filter"
},
"name": {
"type": "string",
"description": "Human-readable display name of the activity type"
},
"primaryAttribute": {
"type": "object",
"description": "Primary Attribute",
"properties": {
"apiName": {
"type": "string",
"description": "API Name of the attribute"
},
"dataType": {
"type": "string",
"description": "Data type of the attribute",
"enum": [
"string",
"boolean",
"integer",
"float",
"link",
"email",
"currency",
"date",
"datetime",
"phone",
"text"
]
},
"description": {
"type": "string",
"description": "Description of the attribute"
},
"isPrimary": {
"type": "boolean",
"description": "Whether the attribute is the primary attribute of the activity type. There may only be one primary attribute at a time"
},
"name": {
"type": "string",
"description": "Human-readable display name of the attribute"
}
},
"required": [
"apiName",
"name"
]
},
"triggerName": {
"type": "string",
"description": "Human-readable name of the associated trigger"
}
},
"required": [
"PCID",
"apiName",
"filterName",
"name",
"primaryAttribute",
"triggerName"
]
}
marketo-activities_create_custom_activity_type_attributes
Create Custom Activity Type Attributes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
apiName | string | Yes | — | API Name of the activity type |
attributes | object[] | No | — | List of attributes to add to the activity type |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"apiName": {
"type": "string",
"description": "API Name of the activity type"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"apiName": {
"type": "string",
"description": "API Name of the attribute"
},
"dataType": {
"type": "string",
"enum": [
"string",
"boolean",
"integer",
"float",
"link",
"email",
"currency",
"date",
"datetime",
"phone",
"text"
],
"description": "Data type of the attribute"
},
"description": {
"type": "string",
"description": "Description of the attribute"
},
"isPrimary": {
"type": "boolean",
"description": "Whether the attribute is the primary attribute of the activity type. There may only be one primary attribute at a time"
},
"name": {
"type": "string",
"description": "Human-readable display name of the attribute"
}
},
"required": [
"apiName",
"name"
]
},
"description": "List of attributes to add to the activity type"
}
},
"required": [
"PCID",
"apiName"
]
}
marketo-activities_delete_custom_activity_type
Delete Custom Activity Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
apiName | string | Yes | — | API Name of the activity type |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"apiName": {
"type": "string",
"description": "API Name of the activity type"
}
},
"required": [
"PCID",
"apiName"
]
}
marketo-activities_delete_custom_activity_type_attributes
Delete Custom Activity Type Attributes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
apiName | string | Yes | — | API Name of the activity type |
attributes | object[] | No | — | List of attributes to add to the activity type |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"apiName": {
"type": "string",
"description": "API Name of the activity type"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"apiName": {
"type": "string",
"description": "API Name of the attribute"
},
"dataType": {
"type": "string",
"enum": [
"string",
"boolean",
"integer",
"float",
"link",
"email",
"currency",
"date",
"datetime",
"phone",
"text"
],
"description": "Data type of the attribute"
},
"description": {
"type": "string",
"description": "Description of the attribute"
},
"isPrimary": {
"type": "boolean",
"description": "Whether the attribute is the primary attribute of the activity type. There may only be one primary attribute at a time"
},
"name": {
"type": "string",
"description": "Human-readable display name of the attribute"
}
},
"required": [
"apiName",
"name"
]
},
"description": "List of attributes to add to the activity type"
}
},
"required": [
"PCID",
"apiName"
]
}
marketo-activities_describe_custom_activity_type
Describe Custom Activity Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
apiName | string | Yes | — | API Name of the activity type |
draft | boolean | No | — | The draft value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"apiName": {
"type": "string",
"description": "API Name of the activity type"
},
"draft": {
"type": "boolean",
"description": "The draft value"
}
},
"required": [
"PCID",
"apiName"
]
}
marketo-activities_discard_custom_activity_type_draft
Discard Custom Activity Type Draft Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
apiName | string | Yes | — | API Name of the activity type |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"apiName": {
"type": "string",
"description": "API Name of the activity type"
}
},
"required": [
"PCID",
"apiName"
]
}
marketo-activities_get_all_activity_types
Get Activity TypesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
marketo-activities_get_campaign_by_id
Get Campaign By Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaignId | integer | Yes | — | Campaign Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaignId": {
"type": "integer",
"description": "Campaign Id"
}
},
"required": [
"PCID",
"campaignId"
]
}
marketo-activities_get_campaigns
Get Campaigns Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer[] | No | — | Comma-separated list of campaign ids to return records for |
name | string[] | No | — | Comma-separated list of names to filter on |
programName | string[] | No | — | Comma-separated list of program names to filter on. If set, will filter to only campaigns which are children of the designated programs. |
workspaceName | string[] | No | — | Comma-separated list of workspace names to filter on. If set, will only return campaigns in the given workspaces. |
batchSize | integer | No | — | Maximum number of records to return. Maximum and default is 300. |
nextPageToken | string | No | — | 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. |
isTriggerable | boolean | No | — | Set to true to return active Campaigns which have a Campaign is Requested trigger and source is Web Service API |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Comma-separated list of campaign ids to return records for"
},
"name": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma-separated list of names to filter on"
},
"programName": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma-separated list of program names to filter on. If set, will filter to only campaigns which are children of the designated programs."
},
"workspaceName": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma-separated list of workspace names to filter on. If set, will only return campaigns in the given workspaces."
},
"batchSize": {
"type": "integer",
"description": "Maximum number of records to return. Maximum and default is 300."
},
"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."
},
"isTriggerable": {
"type": "boolean",
"description": "Set to true to return active Campaigns which have a Campaign is Requested trigger and source is Web Service API"
}
},
"required": [
"PCID"
]
}
marketo-activities_get_custom_activity_types
Get Custom Activity TypesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
marketo-activities_get_daily_errors
Get Daily ErrorsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
marketo-activities_get_daily_usage
Get Daily UsageShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
marketo-activities_get_deleted_leads
Get Deleted Leads Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
nextPageToken | string | Yes | — | Token representation of a datetime returned by the Get Paging Token endpoint. This endpoint will return activities after this datetime |
batchSize | integer | No | — | Maximum number of records to return. Maximum and default is 300. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nextPageToken": {
"type": "string",
"description": "Token representation of a datetime returned by the Get Paging Token endpoint. This endpoint will return activities after this datetime"
},
"batchSize": {
"type": "integer",
"description": "Maximum number of records to return. Maximum and default is 300."
}
},
"required": [
"PCID",
"nextPageToken"
]
}
marketo-activities_get_last7days_errors
Get Weekly ErrorsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
marketo-activities_get_last7days_usage
Get Weekly UsageShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
marketo-activities_get_lead_activities
Get Lead Activities Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
nextPageToken | string | Yes | — | Token representation of a datetime returned by the Get Paging Token endpoint. This endpoint will return activities after this datetime |
activityTypeIds | integer[] | Yes | — | Comma-separated list of activity type ids. These can be retrieved with the Get Activity Types API. |
assetIds | integer[] | No | — | Id of the primary asset for an activity. This is based on the primary asset id of a given activity type. Should only be used when a single activity type is set |
listId | integer | No | — | Id of a static list. If set, will only return activities of members of this static list. |
leadIds | integer[] | No | — | Comma-separated list of lead ids. If set, will only return activities of the leads with these ids. Allows up to 30 entries. |
batchSize | integer | No | — | Maximum number of records to return. Maximum and default is 300. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nextPageToken": {
"type": "string",
"description": "Token representation of a datetime returned by the Get Paging Token endpoint. This endpoint will return activities after this datetime"
},
"activityTypeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Comma-separated list of activity type ids. These can be retrieved with the Get Activity Types API."
},
"assetIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Id of the primary asset for an activity. This is based on the primary asset id of a given activity type. Should only be used when a single activity type is set"
},
"listId": {
"type": "integer",
"description": "Id of a static list. If set, will only return activities of members of this static list."
},
"leadIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Comma-separated list of lead ids. If set, will only return activities of the leads with these ids. Allows up to 30 entries."
},
"batchSize": {
"type": "integer",
"description": "Maximum number of records to return. Maximum and default is 300."
}
},
"required": [
"PCID",
"nextPageToken",
"activityTypeIds"
]
}
marketo-activities_get_lead_changes
Get Lead Changes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
nextPageToken | string | Yes | — | Token representation of a datetime returned by the Get Paging Token endpoint. This endpoint will return activities after this datetime |
fields | string[] | Yes | — | Comma-separated list of field names to return changes for. Field names can be retrieved with the Describe Lead API. |
listId | integer | No | — | Id of a static list. If set, will only return activities of members of this static list. |
leadIds | integer[] | No | — | Comma-separated list of lead ids. If set, will only return activities of the leads with these ids. Allows up to 30 entries. |
batchSize | integer | No | — | Maximum number of records to return. Maximum and default is 300. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nextPageToken": {
"type": "string",
"description": "Token representation of a datetime returned by the Get Paging Token endpoint. This endpoint will return activities after this datetime"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma-separated list of field names to return changes for. Field names can be retrieved with the Describe Lead API."
},
"listId": {
"type": "integer",
"description": "Id of a static list. If set, will only return activities of members of this static list."
},
"leadIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Comma-separated list of lead ids. If set, will only return activities of the leads with these ids. Allows up to 30 entries."
},
"batchSize": {
"type": "integer",
"description": "Maximum number of records to return. Maximum and default is 300."
}
},
"required": [
"PCID",
"nextPageToken",
"fields"
]
}
marketo-activities_get_paging_token
Get Paging Token Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sinceDatetime | string | Yes | — | Earliest datetime to retrieve activities from |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sinceDatetime": {
"type": "string",
"description": "Earliest datetime to retrieve activities from"
}
},
"required": [
"PCID",
"sinceDatetime"
]
}
marketo-activities_schedule_campaign
Schedule Campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaignId | integer | Yes | — | Id of the batch campaign to schedule. |
input | object | No | — | The input value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaignId": {
"type": "integer",
"description": "Id of the batch campaign to schedule."
},
"input": {
"type": "object",
"description": "The input value",
"properties": {
"cloneToProgramName": {
"type": "string",
"description": "Name of the resulting program. When set, this attribute will cause the campaign, parent program, and all of its assets, to be created with the resulting new name. The parent program will be cloned and the newly created campaign will be scheduled. The resulting program is created underneath the parent. Programs with snippets, push notifications, in-app messages, static lists, reports, and social assets may not be cloned in this way"
},
"runAt": {
"type": "string",
"description": "Datetime to run the campaign at. If unset, the campaign will be run five minutes after the call is made"
},
"tokens": {
"type": "array",
"items": {
"type": "object"
},
"description": "List of my tokens to replace during the run of the target campaign. The tokens must be available in a parent program or folder to be replaced during the run"
}
}
}
},
"required": [
"PCID",
"campaignId"
]
}
marketo-activities_trigger_campaign
Request Campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaignId | integer | Yes | — | The id of the campaign to trigger |
input | object | No | — | The input value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"campaignId": {
"type": "integer",
"description": "The id of the campaign to trigger"
},
"input": {
"type": "object",
"description": "The input value",
"properties": {
"leads": {
"type": "array",
"items": {
"type": "object"
},
"description": "List of leads for input"
},
"tokens": {
"type": "array",
"items": {
"type": "object"
},
"description": "List of my tokens to replace during the run of the target campaign. The tokens must be available in a parent program or folder to be replaced during the run"
}
},
"required": [
"leads"
]
}
},
"required": [
"PCID",
"campaignId"
]
}
marketo-activities_update_custom_activity_type
Update Custom Activity Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
apiName | string | Yes | — | API Name of the activity type |
description | string | No | — | The description value |
filterName | string | Yes | — | Human-readable name of the associated filter |
name | string | Yes | — | Human-readable display name of the activity type |
primaryAttribute | object | Yes | — | Primary Attribute |
triggerName | string | Yes | — | Human-readable name of the associated trigger |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"apiName": {
"type": "string",
"description": "API Name of the activity type"
},
"description": {
"type": "string",
"description": "The description value"
},
"filterName": {
"type": "string",
"description": "Human-readable name of the associated filter"
},
"name": {
"type": "string",
"description": "Human-readable display name of the activity type"
},
"primaryAttribute": {
"type": "object",
"description": "Primary Attribute",
"properties": {
"apiName": {
"type": "string",
"description": "API Name of the attribute"
},
"dataType": {
"type": "string",
"description": "Data type of the attribute",
"enum": [
"string",
"boolean",
"integer",
"float",
"link",
"email",
"currency",
"date",
"datetime",
"phone",
"text"
]
},
"description": {
"type": "string",
"description": "Description of the attribute"
},
"isPrimary": {
"type": "boolean",
"description": "Whether the attribute is the primary attribute of the activity type. There may only be one primary attribute at a time"
},
"name": {
"type": "string",
"description": "Human-readable display name of the attribute"
}
},
"required": [
"apiName",
"name"
]
},
"triggerName": {
"type": "string",
"description": "Human-readable name of the associated trigger"
}
},
"required": [
"PCID",
"apiName",
"filterName",
"name",
"primaryAttribute",
"triggerName"
]
}
marketo-activities_update_custom_activity_type_attributes
Update Custom Activity Type Attributes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
apiName | string | Yes | — | API Name of the activity type |
attributes | object[] | No | — | List of attributes to add to the activity type |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"apiName": {
"type": "string",
"description": "API Name of the activity type"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"apiName": {
"type": "string",
"description": "API Name of the attribute"
},
"dataType": {
"type": "string",
"enum": [
"string",
"boolean",
"integer",
"float",
"link",
"email",
"currency",
"date",
"datetime",
"phone",
"text"
],
"description": "Data type of the attribute"
},
"description": {
"type": "string",
"description": "Description of the attribute"
},
"isPrimary": {
"type": "boolean",
"description": "Whether the attribute is the primary attribute of the activity type. There may only be one primary attribute at a time"
},
"name": {
"type": "string",
"description": "Human-readable display name of the attribute"
}
},
"required": [
"apiName",
"name"
]
},
"description": "List of attributes to add to the activity type"
}
},
"required": [
"PCID",
"apiName"
]
}

