人物の部分的な更新

このメソッドを使用して、次のように要求本文で渡されたデータでユーザープロファイルを更新します。
1. 標準プロファイル属性とカスタムプロファイル属性の新しい値が、プロファイルの既存の値を置き換えます。要求で値が渡されない場合、属性はその値を保持します。
2. リクエスト内のタグがプロファイルタグリストに追加されます。
3. リクエストの新しい連絡先情報(メールアドレスと電話番号)がプロファイルの連絡先リストに追加されます。

URLフルパスを表示するには ログイン してください。 詳細はこちら。
patch
/people/2/persons
スコープ:
Request rate limit:
5 requests / 秒 (アカウント1件につき)
query パラメータ
identifier
string
Example: identifier=370329180020364

ユーザー ID: ID タイプは type パラメーターと一致する必要があります。一部のチャネル(Apple Business Chatなど)では、安全でない文字を含む識別子が使用されています。API リクエストで URL エンコードしてください

sender
string
Example: sender=2094832040560427

送信者またはアプリケーション ID。 '送信者' は、IDEXTERNAL_IDPHONEEMAIL を除くすべての識別子の種類に必須です。

type
string
Enum: "ID" "EXTERNAL_ID" "PHONE" "EMAIL" "LINE" "FACEBOOK" "TELEGRAM" "PUSH" "WEB_PUSH" "LIVE_CHAT" "VIBER_BOTS" "INSTAGRAM" "INSTAGRAM_DM" "TWITTER" "APPLE_BUSINESS_CHAT" "KAKAO_SANGDAM" "OPEN_CHANNEL"
Example: type=PHONE

ユーザー ID の種類

Request Body schema:
application/json
すべて折りたたむ -
address
string

個人の住所、256文字以内

birthDate
string

個人の生年月日、形式はYYYY-MM-DD

city
string

個人の市区町村、最大50文字。

computedAttributes
object

タイプ別にグループ化された個人の計算済み属性。

property name*
object
contactInformation
object

電話、電子メール、その他の連絡先のリスト。

email
Array of objects

ユーザーのメールアドレスのリスト。お一人様最大100通のメール。

配列
address
string

ユーザーのメールアドレス。メール形式に準拠し、255文字を超えることはできません。1 人のユーザーが最大 100 個のメールアドレスを持つことができます。

phone
Array of objects

個人の電話番号のリスト。お一人様最大100名まで。

配列
number
string

ユーザーの電話番号。国際形式 で、50 文字を超えることはできません。1 人のユーザーが最大 100 個の電話番号を持つことができます。

country
string

個人の国、最大50文字。

customAttributes
object

個人のカスタム属性のリスト (値あたり最大 4096 文字)。

property name*
object
externalId
string

自社または別の外部システムのユーザーの一意の ID (最大 256 文字)

firstName
string

個人の名、最大255文字。

gender
string
Enum: "MALE" "FEMALE"

人の性別。

integrations
object

統合。

salesforce
object

Salesforce 統合。

contactId
string

Salesforce の連絡先 ID。

leadId
string

Salesforce リード ID。

lastName
string

個人の姓、最大255文字。

middleName
string

個人のミドルネーム、最大50文字。

preferredLanguage
string

その人の好みの言語。2 文字の ISO (xx) または言語地域 BCP-47 (xx-YY) 形式である必要があります。

profilePicture
string

ユーザーのプロフィール写真のURL、最大2083文字。

tags
Array of strings

このユーザーが持っているタグのリスト。

type
string
Enum: "CUSTOMER" "LEAD"

個人のタイプ、デフォルトのタイプはCUSTOMERです。

レスポンス

default

successful response

400

Bad Request

401

Unauthorized

403

Forbidden

429

Too Many Requests

4XX

Error responses

500

Internal Server Error

5XX

Error responses

サンプルをリクエストする

コンテンツタイプ
application/json
コピー
すべて折りたたむ
{
  • "customAttributes":
    {
    • "ShoppingCartList":
      [
      • {
        • "productName": "Sneakers",
        • "productPrice": 25.33,
        • "productCategory": "Sport Sneakers",
        • "productImage": "/image1.png"
        },
      • {
        • "productName": "T-Shirt",
        • "productPrice": 9.99,
        • "productCategory": "Casual",
        • "productImage": "/image2.png"
        }
      ]
    }
}

レスポンス例

コンテンツタイプ
コピー
すべて折りたたむ
{
  • "createdAt": "2018-03-29T13:46:31",
  • "modifiedAt": "2018-03-30T11:25:13",
  • "id": 1,
  • "externalId": "3",
  • "firstName": "Jane",
  • "lastName": "Smith",
  • "address": "67 Farringdon Road",
  • "city": "London",
  • "country": "United Kingdom",
  • "gender": "FEMALE",
  • "birthDate": "1966-01-15",
  • "middleName": "Janie",
  • "preferredLanguage": "en-gb",
  • "profilePicture": "http://profile.com",
  • "origin": "API",
  • "modifiedFrom": "API",
  • "tags":
    [
    • "VIP Customers",
    • "New Customers"
    ],
  • "customAttributes":
    {
    • "Contract Expiry": "2018-06-01",
    • "Company": "Acme",
    • "ShoppingCartList":
      [
      • {
        • "productName": "Sneakers",
        • "productPrice": 25.33,
        • "productCategory": "Sport Sneakers",
        • "productImage": "/image1.png"
        },
      • {
        • "productName": "T-Shirt",
        • "productPrice": 9.99,
        • "productCategory": "Casual",
        • "productImage": "/image2.png"
        }
      ]
    },
  • "contactInformation":
    {
    • "phone":
      [
      • {
        • "number": "41793026727"
        }
      ],
    • "email":
      [
      • {
        • "address": "janewilliams@acme.com"
        }
      ],
    • "push":
      [
      • {
        • "applicationId": "FDCC8516470A3AE97FB8AC218D5D0D3D",
        • "registrationId": "c5db0c47-465c-4e1c-abf8-7cedc275dd19",
        • "additionalData":
          {
          • "birthdate": "1988-07-31",
          • "email": "test@test.com",
          • "firstName": "Jane",
          • "gender": "F",
          • "lastName": "Smith",
          • "middleName": "Janie"
          },
        • "systemData":
          {
          • "cloudType": "GCM",
          • "registrationEnabled": "true",
          • "sdkName": "MobileMessaging SDK",
          • "os": "Android"
          }
        }
      ],
    • "facebook":
      [
      • {
        • "applicationId": "370329180020364",
        • "userId": "2094832040560427",
        • "systemData":
          {
          • "gender": "female",
          • "lastName": "Smith",
          • "firstName": "Jane"
          }
        }
      ],
    • "line":
      [
      • {
        • "applicationId": "1644264921",
        • "userId": "U045147f1ad961bfe996b72bbf417f3c9",
        • "systemData":
          {
          • "displayName": "Jane Smith"
          }
        }
      ],
    • "instagram":
      [
      • {
        • "applicationId": "17841446795352028",
        • "userId": "12461436693342628",
        • "systemData":
          {
          • "displayName": "jane.smith"
          }
        }
      ],
    • "twitter":
      [
      • {
        • "applicationId": "1148203323283877",
        • "userId": "370329180020364",
        • "systemData":
          {
          • "displayName": "Jane Smith"
          }
        }
      ],
    • "appleBusinessChat":
      [
      • {
        • "applicationId": "387465931",
        • "userId": "387465931",
        • "systemData":
          {
          • "displayName": "Jane Smith"
          }
        }
      ]
    }
}

ご不明点は

サポートまでお問い合わせ

ください

© NTTCom Online Marketing Solutions Corporation