指定帐户列表

最近更新： 2024年7月20日
  • 主题：

创建对象：

  • 管理员

命名帐户列出终结点引用

Marketo中的命名帐户列表表示命名帐户的集合。 它们可用于多种情况，包括分类、数据扩充和智能营销活动过滤。 命名帐户列表API允许远程管理这些列表资源及其成员资格。
Content

权限

要查询指定帐户列表，需要只读指定帐户列表或读写指定帐户列表权限。 要创建、更新或删除列表，需要读写指定帐户列表权限。 查询列表成员资格需要只读命名帐户或读写命名帐户权限，而管理成员资格需要读写命名帐户权限。

模型

指定帐户列表的标准字段数量有限，并且不能与自定义字段一起扩展。
Named Account List Field

名称数据类型可更新备注
marketoGUID字符串假指定帐户列表的唯一字符串标识符。 此字段由系统管理，在创建记录时不允许作为字段。 “dedupeBy”：“idField”执行创建或更新时使用的字段。
name字符串真列表的名称。 执行create或update时“dedupeBy”使用的字段：“dedupeFields”。
createdat日期时间假创建列表的日期时间。 此字段由系统管理，在创建或更新记录时不允许作为字段。
更新时间日期时间假列表最近更新的日期时间。 此字段由系统管理，在创建或更新记录时不允许作为字段。
类型字符串假列表的类型。 其值可以为“default”或“external”。 外部列表是由CRM帐户视图创建的列表。

查询

查询帐户列表简单方便。 目前，查询指定帐户列表时只有两个有效的filterTypes：“dedupeFields”和“idField”。 要筛选的字段在查询的filterType参数中设置，值在filterValues as中以逗号分隔的列表中设置。 nextPageToken和batchSize筛选器也是可选参数。

GET /rest/v1/namedAccountLists.json?filterType=idField&filterValues=dff23271-f996-47d7-984f-f2676861b5fb,dff23271-f996-47d7-984f-f2676861b5fc

{
   "requestId": "e42b#14272d07d78",
   "success": true,
   "result": [
      {
         "seq": 0,
         "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb",
         "name": "Saas List",
         "createdAt": "xxxxxxxx",
         "updatedAt": "xxxxxxxx",
         "type": "default",
         "updateable": true
      },
      {
         "seq": 1,
         "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fc",
         "name": "My Account List",
         "createdAt": "xxxxxxxx",
         "updatedAt": "xxxxxxxx",
         "type": "default",
         "updateable": true
      }
   ]
}

创建和更新

创建和更新指定帐户列表记录遵循其他Lead Database创建和更新操作的已建立模式。 请记住，指定帐户列表只有一个可更新的字段name。

端点允许使用两种标准操作类型：“createOnly”和“updateOnly”。  action defaults设置为“createOnly”。

如果操作为updateOnly，则可以指定可选dedupeBy parameter。  允许的值为“dedupeFields”（对应于“name”）或“idField”（对应于“marketoGUID”）。  在createOnly模式中，仅允许“name”作为dedupeBy字段。 一次最多可以提交300条记录。

POST /rest/v1/namedAccountLists.json

{
   "action": "createOnly",
   "dedupeBy": "dedupeFields",
   "input": [
      {
         "name": "SAAS List"
      },
      {
         "name": "Manufacturing (Domestic)"
      }
   ]
}

{
   "requestId": "e42b#14272d07d78",
   "success": true,
   "result": [
      {
         "seq": 0,
         "status": "created",
         "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb"
      },
      {
         "seq": 1,
         "status": "created",
         "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fc"
      }
   ]
}

删除

删除指定帐户列表非常简单，可以根据列表的name或marketoGUID完成。 要选择要使用的键，请在请求的deleteB成员中为name传递“dedupeFields”，为marketoGUID传递“idField”。 如果未设置，则默认为dedupeFields。 一次最多可以删除300条记录。

POST /rest/v1/namedAccountLists/delete.json

{
   "deleteBy": "dedupeFields",
   "input": [
      {
         "name": "Saas List"
      },
      {
         "name": "B2C List"
      },
      {
         "name": "Launchpoint Partner List"
      }
   ]
}

{
   "requestId": "e42b#14272d07d78",
   "success": true,
   "result": [
      {
         "seq": 0,
         "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb",
         "status": "deleted"
      },
      {
         "seq": 1,
         "id": "dff23271-f996-47d7-984f-f2676861b5fc",
         "status": "deleted"
      },
      {
         "seq": 2,
         "status": "skipped",
         "reasons": [
            {
               "code": "1013",
               "message": "Record not found"
            }
         ]
      }
   ]
}

在找不到给定键的记录的情况下，相应的结果项将具有status个“已跳过”，并且会有一个原因和一个代码和消息描述失败，如上面的示例所示。

管理成员资格

查询成员资格

查询指定帐户列表的成员资格非常简单，只需要帐户列表的i。 可选参数包括：

-field — 要包含在响应记录中的以逗号分隔的字段列表
-nextPageToke — 用于分页结果集
-batchSiz — 用于指定要返回的记录数

如果未设置field，则将返回marketoGUI、nam、createdA和updatedA。 batchSiz的最大值和默认值为300。

GET /rest/v1/namedAccountList/{id}/namedAccounts.json

{
   "requestId": "e42b#14272d07d78",
   "success": true,
   "result": [
      {
         "seq": 0,
         "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb",
         "name": "Saas List",
         "createdAt": "2017-02-01T00:00:00Z",
         "updatedAt": "2017-03-05T17:21:15Z"
      },
      {
         "seq": 1,
         "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fc",
         "name": "My Account List",
         "createdAt": "2017-02-01T00:00:00Z",
         "updatedAt": "2017-03-05T17:21:15Z"
      }
   ]
}

添加成员

可以轻松地将指定帐户添加到指定帐户列表。 只能使用其marketoGUID添加帐户。 一次最多可以添加300条记录。

POST /rest/v1/namedAccountList/{id}/namedAccounts.json

{
    "input": [
        {
             "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb"
        },
        {
             "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb"
        }
    ]
}

{
    "requestId": "string",
    "result": [
        {
            "seq": 0,
            "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb",
            "status": "added"
        },
        {
            "seq": 1,
            "marketoGUID": "dff23271-f996-47d7-984f-f2676861b5fb",
            "status": "added"
        }
    ],
    "success": true,
}