Workato埋め込みAPI - カスタマーマネージャー

以下のエンドポイントを使用して、プログラムでカスタマーマネージャーを管理します。

---

クイックリファレンス

タイプ	リソース	説明
GET	/api/customer_managers	すべてのカスタマーマネージャーをリストします。
PUT	/api/customer_managers/:id	カスタマーマネージャーを更新します。
POST	/api/customer_managers	新しいカスタマーマネージャーを作成します。
DELETE	/api/customer_managers/:id	カスタマーマネージャーを削除します。

---

カスタマーマネージャーの一覧

埋め込みパートナーアカウントのすべてのカスタマーマネージャーのリストを返します。

GET /api/customer_managers

サンプルリクエスト

curl  -X GET 'https://www.workato.com/api/customer_managers' \
      -H 'Authorization: Bearer <api_token>' 

レスポンス

{
    "result": {
        "items": [
            {
                "id": 1234,
                "user": {
                    "id": 4321,
                    "name": "ACME-HR",
                    "email": "[email protected]",
                    "avatar_url": "https://example.com"
                },
                "privilege_group": {
                    "id": 247,
                    "name": "Customer Admin",
                    "system": false
                },
            },
            {
                "id": 5678,
                "user": {
                    "id": 8765,
                    "name": "ACME Corp.",
                    "email": "[email protected]",
                    "avatar_url": "https://example.com"
                },
                "privilege_group": {
                    "id": 2,
                    "name": "Admin",
                    "system": true
                },
            }
        ]
    }
}

---

カスタマーマネージャーの更新

埋め込みパートナーアカウントのカスタマーマネージャーの役割を更新します。

PUT /api/customer_managers/:id

URLパラメータ

名前	タイプ	説明
id	string required	役割を更新するカスタマーマネージャーのID。

リクエストボディ

名前	タイプ	説明
role_id	string required	カスタマーマネージャーに設定する役割。

サンプルリクエスト

curl  -X PUT 'https://www.workato.com/api/customer_managers/1234' \
      -H 'Authorization: Bearer <api_token>'\
      -H 'Content-Type: application/json' \
      -d  '{
            "role_id": "2"
          }'

レスポンス

{
    "result": {
        "id": 1234,
        "user": {
            "id": 4321,
            "name": "Alex",
            "email": "[email protected]",
            "avatar_url": ""
        },
        "privilege_group": {
            "id": 2,
            "name": "Admin",
            "system": true
        }
    }
}

---

カスタマーマネージャーの作成

埋め込みパートナーアカウントに新しいカスタマーマネージャーを作成します。

POST /api/customer_managers

クエリパラメータ

名前	タイプ	説明
team_collaborator_id	string required	コラボレーターのID。
role_id	string required	カスタマーマネージャーに設定する役割。

サンプルリクエスト

curl  -X POST 'https://www.workato.com/api/customer_managers/?team_collaborator_id=1&role_id=1' \
      -H 'Authorization: Bearer <api_token>'

レスポンス

{
    "result": {
        "id": 1234,
        "user": {
            "id": 4321,
            "name": "Alex",
            "email": "[email protected]",
            "avatar_url": ""
        },
        "privilege_group": {
            "id": 1,
            "name": "Analyst",
            "system": true
        }
    }
}

---

カスタマーマネージャーの削除

埋め込みパートナーアカウントからカスタマーマネージャーを削除します。

DELETE /api/customer_managers/:id

URLパラメータ

名前	タイプ	説明
id	string required	カスタマーマネージャーのID。

サンプルリクエスト

curl  -X DELETE 'https://www.workato.com/api/customer_managers/1236' \
      -H 'Authorization: Bearer <api_token>'

レスポンス

{
    "result": "ok"
}