跳到主要内容

创建联系人

POST/dmx/v2/contacts

通过标签名称和自定义字段名称创建联系人。 未启用自动创建标签时，标签名称不存在会请求失败；自定义字段名称不存在或匹配不唯一时请求失败。

Request​

请求体参数

    email stringrequired

    邮件地址

    tagNames string[]

    要添加到联系人的标签名称列表。追加语义：保留已有标签，仅添加本次列表中的新标签。

    customFields object[]

    自定义字段值

    fieldName stringrequired

    自定义字段名称。字段名称必须已存在且唯一；不存在或匹配不唯一时请求失败。

    fieldValue string

    自定义字段值

    autoCreateTags boolean

    标签名称不存在时是否自动创建，默认 false。为 false 时，tagNames 中存在未命中标签会请求失败；为 true 时自动创建后追加到联系人。

    conflictPolicy enum

    联系人已存在时的处理策略，默认创建失败。设置为更新策略时，按 email 匹配到已有联系人则用本次提供的数据更新。

    • CONTACT_CONFLICT_POLICY_FAIL_IF_EXISTS: 联系人已存在时返回冲突错误，不更新联系人。
    • CONTACT_CONFLICT_POLICY_UPDATE_IF_EXISTS: 联系人已存在时更新已有联系人。已有标签会保留，tagNames 仅追加新标签。

    Possible values: [CONTACT_CONFLICT_POLICY_FAIL_IF_EXISTS, CONTACT_CONFLICT_POLICY_UPDATE_IF_EXISTS]

响应

    contact object
    id string

    联系人 id

    email string

    邮件地址

    tagNames string[]

    标签名称列表

    customFields object[]

    自定义字段值

    fieldName stringrequired

    自定义字段名称。字段名称必须已存在且唯一；不存在或匹配不唯一时请求失败。

    fieldValue string

    自定义字段值

    createTime string<date-time>

    创建时间

错误

400Bad Request
401

访问未授权，请检查是否传递了正确的授权token

403

无API访问权限，请在域管的应用管理页面完成相关授权

500Internal Server Error