アカウントプロパティ

以下のエンドポイントを使用して、プログラムでアカウントプロパティを管理します。

クイックリファレンス

タイプ	リソース	説明
GET	/api/managed_users/:managed_user_id/properties	接頭辞と一致するカスタマーアカウントに属しているアカウントプロパティのリストを返します。
POST	/api/managed_users/:managed_user_id/properties	カスタマーアカウントにアカウントプロパティをアップサートします。

接頭辞別のプロパティの列挙

接頭辞と一致するカスタマーアカウントに属しているすべてのアカウントプロパティを返します。たとえば、指定された接頭辞が salesforce_sync. の場合は、名前が「salesforce_sync.」で 始まる すべてのアカウントプロパティが返されます。

GET /api/managed_users/:managed_user_id/properties

URL パラメータ

名前	型	説明
managed_user_id	string 必須	Embedded カスタマーアカウント ID または外部 ID。 外部 ID は、E を先頭に付ける必要があります (例 : Ea2300)。結果として返される ID は URL エンコードされます。
prefix	string 必須	指定された接尾辞を持つプロパティを返します。例 : salesforce_sync.。

サンプルリクエスト

curl  -X GET 'https://www.workato.com/api/managed_users/19029/properties?prefix=salesforce_sync.' \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \

レスポンス

{
    "result": {
        "salesforce_sync.object_name": "Account",
        "salesforce_sync.object_field": "Id"
    }
}

プロパティのアップサート

カスタマーアカウントにアカウントプロパティをアップサートします。リクエストで指定されたプロパティの名前で照合します。

POST /api/managed_users/:managed_user_id/properties

パラメータ

名前	型	説明
managed_user_id	string 必須	Embedded カスタマーアカウント ID または外部 ID。 外部 ID は、E を先頭に付ける必要があります (例 : Ea2300)。結果として返される ID は URL エンコードされます。

ペイロード

名前	型	説明
properties	Hash 必須	アップサートするプロパティの名前と値を含めます。

サンプルリクエスト

curl  -X POST https://www.workato.com/api/managed_users/19029/properties \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \
      -d '{ "properties": { "zendesk.object": "Ticket", "zendesk.key": "ticket_id" }}'

レスポンス

{
  "success": true
}