Version 1
Connector Overview: This page documents all 147 actions for the Marketoactivitiesconnector v1.
Activities (16)
POST Add Custom Activities
/rest/v1/activities/external.json
Allows insertion of custom activities associated to given lead records. Requires provisioning of custom activity types to utilize. Required Permissions: Read-Write Activity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Approve Custom Activity Type
/rest/v1/activities/external/type/{apiName}/approve.json
Approves the current draft of the type, and makes it the live version. This will delete the current live version of the type. Required Permissions: Read-Write Activity Metadata
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Custom Activity Type
/rest/v1/activities/external/type.json
Creates a new custom activity type draft in the target instance. Required Permissions: Read-Write Activity Metadata
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Custom Activity Type Attributes
/rest/v1/activities/external/type/{apiName}/attributes/create.json
Adds activity attributes to the target type. These are added to the draft version of the type. Required Permissions: Read-Write Activity Metadata
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Custom Activity Type
/rest/v1/activities/external/type/{apiName}/delete.json
Deletes the target custom activity type. The type must first be removed from use by any assets, such as triggers or filters. Required Permissions: Read-Write Activity Metadata
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Custom Activity Type Attributes
/rest/v1/activities/external/type/{apiName}/attributes/delete.json
Deletes the target attributes from the custom activity type draft. The apiName of each attribute is the primary key for the update. Required Permissions: Read-Write Activity Metadata
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Describe Custom Activity Type
/rest/v1/activities/external/type/{apiName}/describe.json
Returns metadata for a specific custom activity type. Required Permissions: Read-Only Activity Metadata, Read-Write Activity Metadata
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Discard Custom Activity Type Draft
/rest/v1/activities/external/type/{apiName}/discardDraft.json
Discards the current draft of the custom activity type. Required Permissions: Read-Write Activity Metadata
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Activity Types
/rest/v1/activities/types.json
Returns a list of available activity types in the target instance, along with associated metadata of each type. Required Permissions: Read-Only Activity, Read-Write Activity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Custom Activity Types
/rest/v1/activities/external/types.json
Returns metadata regarding custom activities provisioned in the target instance. Required Permissions: Read-Only Activity Metadata, Read-Write Activity Metadata
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Deleted Leads
/rest/v1/activities/deletedleads.json
Returns a list of leads deleted after a given datetime. Deletions greater than 14 days old may be pruned. Required Permissions: Read-Only Activity, Read-Write Activity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Lead Activities
/rest/v1/activities.json
Returns a list of activities from after a datetime given by the nextPageToken parameter. Also allows for filtering by lead static list membership, or by a list of up to 30 lead ids. Required Permissions: Read-Only Activity, Read-Write Activity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Lead Changes
/rest/v1/activities/leadchanges.json
Returns a list of Data Value Changes and New Lead activities after a given datetime. Required Permissions: Read-Only Activity, Read-Write Activity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Paging Token
/rest/v1/activities/pagingtoken.json
Returns a paging token for use in retrieving activities and data value changes. Required Permissions: Read-Only Activity, Read-Write Activity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Custom Activity Type
/rest/v1/activities/external/type/{apiName}.json
Updates the target custom activity type. All changes are applied to the draft version of the type. Required Permissions: Read-Write Activity Metadata
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Custom Activity Type Attributes
/rest/v1/activities/external/type/{apiName}/attributes/update.json
Updates the attributes of the custom activity type draft. The apiName of each attribute is the primary key for the update. Required Permissions: Read-Write Activity Metadata
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Bulk Export Activities (6)
POST Cancel Export Activity Job
/bulk/v1/activities/export/{exportId}/cancel.json
Cancel export job. Required Permissions: Read-Only Activity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Export Activity Job
/bulk/v1/activities/export/create.json
Create export job for search criteria defined via "filter" parameter. Request returns the "exportId" which is passed as a parameter in subsequent calls to Bulk Export Activities endpoints. Use Enqueue Export Activity Job endpoint to queue the export job for processing. Use Get Export Activity Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Activity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Enqueue Export Activity Job
/bulk/v1/activities/export/{exportId}/enqueue.json
Enqueue export job. This will place export job in queue, and will start the job when computing resources become available. The export job must be in "Created" state. Use Get Export Activity Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Activity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Export Activity File
/bulk/v1/activities/export/{exportId}/file.json
Returns the file content of an export job. The export job must be in "Completed" state. Use Get Export Activity Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Activity
The file format is specified by calling the Create Export Activity Job endpoint. The following is an example of the default file format ("CSV"). Note that the "attributes" field is formatted as JSON.
marketoGUID,leadId,activityDate,activityTypeId,campaignId,primaryAttributeValueId,primaryAttributeValue, attributes
122323,6,2013-09-26T06:56:35+0000,12,11,6,Owyliphys Iledil,[{"name":"Source Type","value":"Web page visit"}]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Export Activity Job Status
/bulk/v1/activities/export/{exportId}/status.json
Returns status of an export job. Job status is available for 30 days after Completed or Failed status was reached. Required Permissions: Read-Only Activity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Export Activity Jobs
/bulk/v1/activities/export.json
Returns a list of export jobs that were created in the past 7 days. Required Permissions: Read-Only Activity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Bulk Export Custom Objects (6)
POST Cancel Export Custom Object Job
/bulk/v1/customobjects/{apiName}/export/{exportId}/cancel.json
Cancel export job. Required Permissions: Read-Only Custom Object
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Export Custom Object Job
/bulk/v1/customobjects/{apiName}/export/create.json
Create export job for search criteria defined via "filter" parameter. Request returns the "exportId" which is passed as a parameter in subsequent calls to Bulk Export Custom Object endpoints. Use Enqueue Export Custom Object Job endpoint to queue the export job for processing. Use Get Export Custom Object Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Custom Object
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Enqueue Export Custom Object Job
/bulk/v1/customobjects/{apiName}/export/{exportId}/enqueue.json
Enqueue export job. This will place export job in queue, and will start the job when computing resources become available. The export job must be in "Created" state. Use Get Export Custom Object Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Custom Object
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Export Custom Object File
/bulk/v1/customobjects/{apiName}/export/{exportId}/file.json
Returns the file content of an export job. The export job must be in "Completed" state. Use Get Export Custom Object Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Custom Object
The file format is specified by calling the Create Export Custom Object Job endpoint. The following is an example of the default file format ("CSV").
leadId,marketoGUID,itemName
11,c93f0494-bbd9-44e8-9c0e-dae9b525073f,Hoka One One Mach 4
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Export Custom Object Job Status
/bulk/v1/customobjects/{apiName}/export/{exportId}/status.json
Returns status of an export job. Job status is available for 30 days after Completed or Failed status was reached. Required Permissions: Read-Only Custom Object
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Export Custom Object Jobs
/bulk/v1/customobjects/{apiName}/export.json
Returns a list of export jobs that were created in the past 7 days. Required Permissions: Read-Only Custom Object
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Bulk Export Leads (6)
POST Cancel Export Lead Job
/bulk/v1/leads/export/{exportId}/cancel.json
Cancel export job. Required Permissions: Read-Only Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Export Lead Job
/bulk/v1/leads/export/create.json
Create export job for search criteria defined via "filter" parameter. Request returns the "exportId" which is passed as a parameter in subsequent calls to Bulk Export Leads endpoints. Use Enqueue Export Lead Job endpoint to queue the export job for processing. Use Get Export Lead Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Enqueue Export Lead Job
/bulk/v1/leads/export/{exportId}/enqueue.json
Enqueue export job. This will place export job in queue, and will start the job when computing resources become available. The export job must be in "Created" state. Use Get Export Lead Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Export Lead File
/bulk/v1/leads/export/{exportId}/file.json
Returns the file content of an export job. The export job must be in "Completed" state. Use Get Export Lead Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead
The file format is specified by calling the Create Export Lead Job endpoint. The following is an example of the default file format ("CSV").
firstName,lastName,email
Marvin,Gaye,marvin.gaye@motown.com
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Export Lead Job Status
/bulk/v1/leads/export/{exportId}/status.json
Returns status of an export job. Job status is available for 30 days after Completed or Failed status was reached. Required Permissions: Read-Only Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Export Lead Jobs
/bulk/v1/leads/export.json
Returns a list of export jobs that were created in the past 7 days. Required Permissions: Read-Only Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Bulk Export Program Members (6)
POST Cancel Export Program Member Job
/bulk/v1/program/members/export/{exportId}/cancel.json
Cancel export job. Required Permissions: Read-Only Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Export Program Member Job
/bulk/v1/program/members/export/create.json
Create export job for search criteria defined via "filter" parameter. Request returns the "exportId" which is passed as a parameter in subsequent calls to Bulk Export Program Members endpoints. Use Enqueue Export Program Member Job endpoint to queue the export job for processing. Use Get Export Program Member Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Enqueue Export Program Member Job
/bulk/v1/program/members/export/{exportId}/enqueue.json
Enqueue export job. This will place export job in queue, and will start the job when computing resources become available. The export job must be in "Created" state. Use Get Export Program Member Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Export Program Member File
/bulk/v1/program/members/export/{exportId}/file.json
Returns the file content of an export job. The export job must be in "Completed" state. Use Get Export Program Member Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Lead
The file format is specified by calling the Create Export Program Member Job endpoint. The following is an example of the default file format ("CSV").
firstName,lastName,email
Marvin,Gaye,marvin.gaye@motown.com
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Export Program Member Job Status
/bulk/v1/program/members/export/{exportId}/status.json
Returns status of an export job. Job status is available for 30 days after Completed or Failed status was reached. Required Permissions: Read-Only Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Export Program Member Jobs
/bulk/v1/program/members/export.json
Returns a list of export jobs that were created in the past 7 days. Required Permissions: Read-Only Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Bulk Import Custom Objects (4)
GET Get Import Custom Object Failures
/bulk/v1/customobjects/{apiName}/import/{batchId}/failures.json
Returns the list of failures for the import batch job. Required Permissions: Read-Write Custom Object
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Import Custom Object Status
/bulk/v1/customobjects/{apiName}/import/{batchId}/status.json
Returns the status of an import batch job. Required Permissions: Read-Write Custom Object
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Import Custom Object Warnings
/bulk/v1/customobjects/{apiName}/import/{batchId}/warnings.json
Returns the list of warnings for the import batch job. Required Permissions: Read-Write Custom Object
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Import Custom Objects
/bulk/v1/customobjects/{apiName}/import.json
Imports a file containing data records into the target instance. Required Permissions: Read-Write Custom Object
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Bulk Import Leads (4)
GET Get Import Lead Failures
/bulk/v1/leads/batch/{batchId}/failures.json
Returns the list of failures for the import batch job. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Import Lead Status
/bulk/v1/leads/batch/{batchId}.json
Returns the status of an import batch job. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Import Lead Warnings
/bulk/v1/leads/batch/{batchId}/warnings.json
Returns the list of warnings for the import batch job. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Import Leads
/bulk/v1/leads.json
Imports a file containing data records into the target instance. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Bulk Import Program Members (4)
GET Get Import Program Member Failures
/bulk/v1/program/members/import/{batchId}/failures.json
Returns the list of failures for the import batch job. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Import Program Member Status
/bulk/v1/program/members/import/{batchId}/status.json
Returns the status of an import batch job. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Import Program Member Warnings
/bulk/v1/program/members/import/{batchId}/warnings.json
Returns the list of warnings for the import batch job. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Import Program Members
/bulk/v1/program/{programId}/members/import.json
Imports a file containing data records into the target instance. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Campaigns (4)
GET Get Campaign By Id
/rest/v1/campaigns/{campaignId}.json
Returns the record of a campaign by its id. Required Permissions: Read-Only Campaigns, Read-Write Campaigns
Note: This endpoint has been superceded. Use Get Smart Campaign by Id endpoint instead.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Campaigns
/rest/v1/campaigns.json
Returns a list of campaign records. Required Permissions: Read-Only Campaigns, Read-Write Campaigns
Note: This endpoint has been superceded. Use Get Smart Campaigns endpoint instead.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Request Campaign
/rest/v1/campaigns/{campaignId}/trigger.json
Passes a set of leads to a trigger campaign to run through the campaign's flow. The designated campaign must have a Campaign is Requested: Web Service API trigger, and must be active. My tokens local to the campaign's parent program can be overridden for the run to customize content. A maximum of 100 leads are allowed per call. Required Permissions: Execute Campaign
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Schedule Campaign
/rest/v1/campaigns/{campaignId}/schedule.json
Remotely schedules a batch campaign to run at a given time. My tokens local to the campaign's parent program can be overridden for the run to customize content. When using the "cloneToProgramName" parameter described below, this endpoint is limited to 20 calls per day. Required Permissions: Execute Campaign
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Companies (6)
POST Delete Companies
/rest/v1/companies/delete.json
Deletes the included list of company records from the destination instance. Required Permissions: Read-Write Company
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Describe Companies
/rest/v1/companies/describe.json
Returns metadata about companies and the fields available for interaction via the API. Required Permissions: Read-Only Company, Read-Write Company
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Companies
/rest/v1/companies.json
Retrieves company records from the destination instance based on the submitted filter. Required Permissions: Read-Only Company, Read-Write Company
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Company Field by Name
/rest/v1/companies/schema/fields/{fieldApiName}.json
Retrieves metadata for single company field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Company Fields
/rest/v1/companies/schema/fields.json
Retrieves metadata for all company fields in the target instance. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Sync Companies
/rest/v1/companies.json
Allows inserting, updating, or upserting of company records into Marketo. Required Permissions: Read-Write Company
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Custom Objects (17)
POST Add Custom Object Type Fields
/rest/v1/customobjects/schema/{apiName}/addField.json
Adds fields to custom object type. Required Permissions: Read-Write Custom Object Type
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Approve Custom Object Type
/rest/v1/customobjects/schema/{apiName}/approve.json
Approves the current draft of the type, and makes it the live version. This will delete the current live version of the type. Required Permissions: Read-Write Custom Object Type
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Custom Object Type
/rest/v1/customobjects/schema/{apiName}/delete.json
Deletes the target custom object type. The type must first be removed from use by any assets, such as triggers or filters. Required Permissions: Read-Write Custom Object Type
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Custom Object Type Fields
/rest/v1/customobjects/schema/{apiName}/deleteField.json
Deletes fields from custom object type. Required Permissions: Read-Write Custom Object Type
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Custom Objects
/rest/v1/customobjects/{customObjectName}/delete.json
Deletes a given set of custom object records. Required Permissions: Read-Write Custom Object
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Describe Custom Object Type
/rest/v1/customobjects/schema/{apiName}/describe.json
Returns metadata regarding a given custom object type (including relationships and fields). Required Permissions: Read-Only Custom Object Type, Read-Write Custom Object Type
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Describe Custom Objects
/rest/v1/customobjects/{customObjectName}/describe.json
Returns metadata regarding a given custom object. Required Permissions: Read-Only Custom Object, Read-Write Custom Object
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Discard Custom Object Type Draft
/rest/v1/customobjects/schema/{apiName}/discardDraft.json
Discards the current draft of the custom object type. Required Permissions: Read-Write Custom Object Type
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Custom Object Dependent Assets
/rest/v1/customobjects/schema/{apiName}/dependentAssets.json
Returns a list of dependent assets for a custom object type, including their in-instance location. Required Permissions: Read-Only Custom Object Type, Read-Write Custom Object Type
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Custom Object Linkable Objects
/rest/v1/customobjects/schema/linkableObjects.json
Returns a list of linkable custom objects and their fields. Required Permissions: Read-Only Custom Object Type, Read-Write Custom Object Type
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Custom Object Type Field Data Types
/rest/v1/customobjects/schema/fieldDataTypes.json
Returns a list of permissible data types that are assigned to custom object fields. Required Permissions: Read-Only Custom Object Type, Read-Write Custom Object Type
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Custom Objects
/rest/v1/customobjects/{customObjectName}.json
Retrieves a list of custom objects records based on filter and set of values. There are two unique types of requests for this endpoint: one is executed normally using a GET with URL parameters, the other is by passing a JSON object in the body of a POST and specifying _method=GET in the querystring. The latter is used when dedupeFields attribute has more than one field, which is known as a "compound key". Required Permissions: Read-Only Custom Object, Read-Write Custom Object
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET List Custom Object Types
/rest/v1/customobjects/schema.json
Returns a list of Custom Object Types available in the target instance, along with id, deduplication, relationship, and field information for each type. Required Permissions: Read-Only Custom Object Type, Read-Write Custom Object Type
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET List Custom Objects
/rest/v1/customobjects.json
Returns a list of Custom Object types available in the target instance, along with id and deduplication information for each type. Required Permissions: Read-Only Custom Object, Read-Write Custom Object
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Sync Custom Object Type
/rest/v1/customobjects/schema.json
Inserts, updates, or upserts custom object type record to the target instance. Required Permissions: Read-Write Custom Object Type
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Sync Custom Objects
/rest/v1/customobjects/{customObjectName}.json
Inserts, updates, or upserts custom object records to the target instance. Required Permissions: Read-Write Custom Object
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Custom Object Type Field
/rest/v1/customobjects/schema/{apiName}/{fieldApiName}/updateField.json
Updates a field in custom object type. Required Permissions: Read-Write Custom Object Type
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Leads (22)
POST Associate Lead
/rest/v1/leads/{leadId}/associate.json
Associates a known Marketo lead record to a munchkin cookie and its associated web acitvity history. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Change Lead Program Status
/rest/v1/leads/programs/{programId}/status.json
Changes the program status of a list of leads in a target program. Only existing members of the program may have their status changed with this API. Required Permissions: Read-Write Lead
Note: This endpoint has been superceded. Use Sync Program Member Status endpoint instead.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Lead Fields
/rest/v1/leads/schema/fields.json
Create lead fields in the target instance. Required Permissions: Read-Write Schema Custom Field
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Leads
/rest/v1/leads/delete.json
Delete a list of leads from the destination instance. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Describe Lead
/rest/v1/leads/describe.json
Returns metadata about lead objects in the target instance, including a list of all fields available for interaction via the APIs. Required Permissions: Read-Only Lead, Read-Write Lead
Note: This endpoint has been superceded. Use Describe Lead2 endpoint instead.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Describe Lead2
/rest/v1/leads/describe2.json
Returns list of searchable fields on lead objects in the target instance. Required Permissions: Read-Only Lead, Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Describe Program Member
/rest/v1/program/members/describe.json
Returns metadata about program member objects in the target instance, including a list of all fields available for interaction via the APIs. Required Permissions: Read-Only Lead, Read-Write Lead
Note: This endpoint has been superceded. Use Describe Program Member endpoint instead.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Lead Field by Name
/rest/v1/leads/schema/fields/{fieldApiName}.json
Retrieves metadata for single lead field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Lead Fields
/rest/v1/leads/schema/fields.json
Retrieves metadata for all lead fields in the target instance. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Lead Partitions
/rest/v1/leads/partitions.json
Returns a list of available partitions in the target instance. Required Permissions: Read-Only Lead, Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Lead by Id
/rest/v1/lead/{leadId}.json
Retrieves a single lead record through its Marketo id. Required Permissions: Read-Only Lead, Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Leads by Filter Type
/rest/v1/leads.json
Returns a list of up to 300 leads based on a list of values in a particular field. Required Permissions: Read-Only Lead, Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Leads by Program Id
/rest/v1/leads/programs/{programId}.json
Retrieves a list of leads which are members of the designated program. Required Permissions: Read-Only Lead, Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Lists by Lead Id
/rest/v1/leads/{leadId}/listMembership.json
Query static list membership for one lead. Required Permissions: Read-Only Asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Programs by Lead Id
/rest/v1/leads/{leadId}/programMembership.json
Query program membership for one lead. Required Permissions: Read-Only Asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Smart Campaigns by Lead Id
/rest/v1/leads/{leadId}/smartCampaignMembership.json
Query smart campaign membership for one lead. Required Permissions: Read-Only Asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Merge Leads
/rest/v1/leads/{leadId}/merge.json
Merges two or more known lead records into a single lead record. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Push Lead to Marketo
/rest/v1/leads/push.json
Upserts a lead and generates a Push Lead to Marketo activity. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Submit Form
/rest/v1/leads/submitForm.json
Upserts a lead and generates a "Fill out Form" activity which is associated back to program and/or campaign. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Sync Leads
/rest/v1/leads.json
Syncs a list of leads to the target instance. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Lead Field
/rest/v1/leads/schema/fields/{fieldApiName}.json
Update metadata for a lead field in the target instance. See update rules here. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Lead Partition
/rest/v1/leads/partitions.json
Updates the lead partition for a list of leads. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Named Account Lists (6)
POST Add Named Account List Members
/rest/v1/namedAccountList/{id}/namedAccounts.json
Adds named account records to a named account list. Required Permissions: Read-Write Named Account
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Named Account Lists
/rest/v1/namedAccountLists/delete.json
Delete named account lists by dedupe fields, or by id field. Required Permissions: Read-Write Named Account List
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Named Account List Members
/rest/v1/namedAccountList/{id}/namedAccounts.json
Retrieves the named accounts which are members of the given list. Required Permissions: Read-Only Named Account, Read-Write Named Account
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Named Account Lists
/rest/v1/namedAccountLists.json
Retrieves a list of named account list records based on the filter type and values given. Required Permissions: Read-Only Named Account List, Read-Write Named Account List
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Remove Named Account List Members
/rest/v1/namedAccountList/{id}/namedAccounts/remove.json
Removes named account members from a named account list. Required Permissions: Read-Write Named Account
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Sync Named Account Lists
/rest/v1/namedAccountLists.json
Creates and/or updates named account list records. Required Permissions: Read-Write Named Account List
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Named Accounts (6)
POST Delete NamedAccounts
/rest/v1/namedaccounts/delete.json
Deletes a list of namedaccount records from the target instance. Input records should have only one member, based on the value of 'dedupeBy'. Required Permissions: Read-Write Named Account
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Describe NamedAccounts
/rest/v1/namedaccounts/describe.json
Returns metadata about namedaccounts and the fields available for interaction via the API. Required Permissions: Read-Only Named Account, Read-Write Named Account
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Named Account Field by Name
/rest/v1/namedaccounts/schema/fields/{fieldApiName}.json
Retrieves metadata for single named account field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Named Account Fields
/rest/v1/namedaccounts/schema/fields.json
Retrieves metadata for all named account fields in the target instance. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get NamedAccounts
/rest/v1/namedaccounts.json
Retrieves namedaccount records from the destination instance based on the submitted filter. Required Permissions: Read-Only Named Account, Read-Write Named Account
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Sync NamedAccounts
/rest/v1/namedaccounts.json
Allows inserts, updates, or upserts of namedaccounts to the target instance. Required Permissions: Read-Write Named Account
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Opportunities (10)
POST Delete Opportunities
/rest/v1/opportunities/delete.json
Deletes a list of opportunity records from the target instance. Input records should only have one member, based on the value of 'dedupeBy'. Required Permissions: Read-Write Named Opportunity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Opportunity Roles
/rest/v1/opportunities/roles/delete.json
Deletes a list of opportunities from the target instance. Required Permissions: Read-Write Named Opportunity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Describe Opportunity
/rest/v1/opportunities/describe.json
Returns object and field metadata for Opportunity type records in the target instance. Required Permissions: Read-Only Opportunity, Read-Write Named Opportunity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Describe Opportunity Role
/rest/v1/opportunities/roles/describe.json
Returns object and field metadata for Opportunity Roles in the target instance. Required Permissions: Read-Only Opportunity, Read-Write Named Opportunity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Opportunities
/rest/v1/opportunities.json
Returns a list of opportunities based on a filter and set of values. Required Permissions: Read-Only Opportunity, Read-Write Named Opportunity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Opportunity Field by Name
/rest/v1/opportunities/schema/fields/{fieldApiName}.json
Retrieves metadata for single opportunity field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Opportunity Fields
/rest/v1/opportunities/schema/fields.json
Retrieves metadata for all opportunity fields in the target instance. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Opportunity Roles
/rest/v1/opportunities/roles.json
Returns a list of opportunity roles based on a filter and set of values. Required Permissions: Read-Only Opportunity, Read-Write Named Opportunity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Sync Opportunities
/rest/v1/opportunities.json
Allows inserting, updating, or upserting of opportunity records into the target instance. Required Permissions: Read-Write Named Opportunity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Sync Opportunity Roles
/rest/v1/opportunities/roles.json
Allows inserts, updates and upserts of Opportunity Role records in the target instance. Required Permissions: Read-Write Named Opportunity
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Program Members (9)
POST Create Program Member Fields
/rest/v1/programs/members/schema/fields.json
Create program member fields in the target instance. Required Permissions: Read-Write Schema Custom Field
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Delete Program Members
/rest/v1/programs/{programId}/members/delete.json
Delete a list of members from the destination instance. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Describe Program Member
/rest/v1/programs/members/describe.json
Returns metadata about program member objects in the target instance, including a list of all fields available for interaction via the APIs. Required Permissions: Read-Only Lead, Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Program Member Field by Name
/rest/v1/programs/members/schema/fields/{fieldApiName}.json
Retrieves metadata for single program member field. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Program Member Fields
/rest/v1/programs/members/schema/fields.json
Retrieves metadata for all program member fields in the target instance. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Program Members
/rest/v1/programs/{programId}/members.json
Returns a list of up to 300 program members on a list of values in a particular field. If you specify a filterType that is a custom field, the custom field’s dataType must be either “string” or “integer”. If you specify a filterType other than “leadId”, a maximum of 100,000 program member records can be processed by the request. Required Permissions: Read-Only Lead, Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Sync Program Member Data
/rest/v1/programs/{programId}/members.json
Changes the program member data of a list of leads in a target program. Only existing members of the program may have their data changed with this API. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Sync Program Member Status
/rest/v1/programs/{programId}/members/status.json
Changes the program member status of a list of leads in a target program. If member is not part of the program, member is added to the program. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Program Member Field
/rest/v1/programs/members/schema/fields/{fieldApiName}.json
Update metadata for a program member field in the target instance. See update rules here. Required Permissions: Read-Write Schema Standard Field, Read-Write Schema Custom Field
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Sales Persons (4)
POST Delete SalesPersons
/rest/v1/salespersons/delete.json
Deletes a list of salesperson records from the target instance. Input records should have only one member, based on the value of 'dedupeBy'. Required Permissions: Read-Write Sales Person
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Describe SalesPersons
/rest/v1/salespersons/describe.json
Returns metadata about salespersons and the fields available for interaction via the API. Required Permissions: Read-Only Sales Person, Read-Write Sales Person
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get SalesPersons
/rest/v1/salespersons.json
Retrieves salesperson records from the destination instance based on the submitted filter. Required Permissions: Read-Only Sales Person, Read-Write Sales Person
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Sync SalesPersons
/rest/v1/salespersons.json
Allows inserts, updates, or upserts of salespersons to the target instance. Required Permissions: Read-Write Sales Person
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Static Lists (7)
POST Add to List
/rest/v1/lists/{listId}/leads.json
Adds a given set of person records to a target static list. There is a limit of 300 lead ids per request. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Leads By List Id
/rest/v1/list/{listId}/leads.json
Retrieves person records which are members of the given static list. Required Permissions: Read-Only Lead, Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Leads By List Id
/rest/v1/lists/{listId}/leads.json
Retrieves person records which are members of the given static list. Required Permissions: Read-Only Lead, Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get List by Id
/rest/v1/lists/{listId}.json
Returns a list record by its id. Required Permissions: Read-Only Lead, Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Lists
/rest/v1/lists.json
Returns a set of static list records based on given filter parameters. Required Permissions: Read-Only Lead, Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Member of List
/rest/v1/lists/{listId}/leads/ismember.json
Checks if leads are members of a given static list. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Remove from List
/rest/v1/lists/{listId}/leads.json
Removes a given set of person records from a target static list. Required Permissions: Read-Write Lead
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Usage (4)
GET Get Daily Errors
/rest/v1/stats/errors.json
Retrieves a count of each error type they have encountered in the current day. Required Permissions: None
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Daily Usage
/rest/v1/stats/usage.json
Returns the number of calls consumed for the day. Required Permissions: None
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Weekly Errors
/rest/v1/stats/errors/last7days.json
Returns a count of each error type they have encountered in the past 7 days. Required Permissions: None
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Weekly Usage
/rest/v1/stats/usage/last7days.json
Returns the number of calls consumed in the past 7 days. Required Permissions: None
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |