潜在客户

最近更新： 2024年12月10日
  • 主题：

创建对象：

  • 管理员

潜在客户终结点引用

Marketo Lead的API为针对潜在客户记录的简单CRUD应用程序提供了一系列功能，并提供了修改潜在客户在静态列表和程序中的成员资格，以及启动潜在客户的Smart Campaign处理等功能。

描述

Leads API的关键功能之一是Describe方法。 使用描述潜在客户检索可用于通过REST API进行交互的字段的完整列表，以及每个字段的元数据：

  • 数据类型
  • REST API名称
  • 长度（如果适用）
  • 只读
  • 友好标签

描述是字段是否可用以及有关这些字段的元数据的主要真实来源。

请求

GET /rest/v1/leads/describe.json

响应

{
   "requestId":"37ca#1475b74e276",
   "success":true,
   "result":[
      {
         "id":2,
         "displayName":"Company Name",
         "dataType":"string",
         "length":255,
         "rest":{
            "name":"company",
            "readOnly":false
         },
         "soap":{
            "name":"Company",
            "readOnly":false
         }
      }
}

通常，响应在结果数组中包含一组更多的字段，但出于演示目的，我们忽略了它们。 结果数组中的每一项都对应于潜在客户记录中可用的字段，并且至少具有id、displayName和数据类型。 对于给定字段，rest和soap子对象可能存在，也可能不存在，并且其存在将指示该字段在REST或SOAP API中是否有效。 readOnly属性通过相应的API (REST或SOAP)指示字段是否为只读。 length属性指示字段的最大长度（如果存在）。 dataType属性指示字段的数据类型。

查询

商机检索的主要方法有两种：按ID获取商机，和按过滤器类型获取商机。 按ID获取潜在客户采用单个潜在客户ID作为路径参数并返回单个潜在客户记录。

或者，您可以传递一个字段参数，其中包含要返回的以逗号分隔的字段名称列表。 如果此请求中未包含字段参数，则返回以下默认字段： email、updatedAt、createdAt、lastName、firstName和id。 在请求字段列表时，如果请求的是特定字段但未返回，则该值默认为空。

请求

GET /rest/v1/lead/{id}.json

响应

{
   "requestId": "10226#14d3049e51b",
   "success": true,
   "result": [
      {
         "id": 318581,
         "updatedAt":"2015-05-07T11:47:30-08:00"
         "lastName": "Doe",
         "email": "jdoe@marketo.com",
         "createdAt": "2015-05-01T16:47:30-08:00",
         "firstName": "John"
      }
   ]
}

对于此方法，在结果数组的第一个位置始终有单个记录。

按过滤器类型获取潜在客户将返回相同类型的记录，但每页最多可能返回300条记录。 它需要filterType和filterValues查询参数。

filterType接受任何自定义字段，或大多数常用字段。 调用Describe2端点以获取允许在filterType中使用的可搜索字段的完整列表。 按自定义字段搜索时，仅支持以下数据类型： string、email、integer。 您可以使用上述Describe方法获取字段详细信息（描述、类型等）。

filterValues以逗号分隔格式接受最多300个值。 该调用将搜索潜在客户字段与所包含filterValues之一匹配的记录。 如果与商机过滤器匹配的商机数量大于1,000，则会返回错误：“1003，有太多结果与过滤器匹配”。

如果GET请求的总长度超过8 KB，则会返回HTTP错误：“414， URI过长”（根据RFC 7231）。 作为解决方法，您可以将您的GET更改为POST，添加_method=GET参数，并将查询字符串放入请求正文中。