# Workato Embedded API - Customer managers
Use the following endpoints to programmatically manage customer managers.
# Quick reference
Type | Resource | Description |
---|---|---|
GET | /api/customer_managers | List all customer managers. |
PUT | /api/customer_managers/:id | Update a customer manager. |
POST | /api/customer_managers | Create a new customer manager. |
DELETE | /api/customer_managers/:id | Delete a customer manager. |
# List customer managers
Returns a list of all customer managers in an Embedded partner's account.
GET /api/customer_managers
# Sample request
curl -X GET 'https://www.workato.com/api/customer_managers' \
-H 'Authorization: Bearer <api_token>'
# Response
{
"result": {
"items": [
{
"id": 1234,
"user": {
"id": 4321,
"name": "ACME-HR",
"email": "alex@example.com.com",
"avatar_url": "https://example.com"
},
"privilege_group": {
"id": 247,
"name": "Customer Admin",
"system": false
},
},
{
"id": 5678,
"user": {
"id": 8765,
"name": "ACME Corp.",
"email": "ariel@example.com",
"avatar_url": "https://example.com"
},
"privilege_group": {
"id": 2,
"name": "Admin",
"system": true
},
}
]
}
}
# Update a customer manager
Update a customer manager's role in an Embedded partner's account.
PUT /api/customer_managers/:id
# URL parameters
Name | Type | Description |
---|---|---|
id | string required | The ID of the customer manager whose role you plan to update. |
# Request body
Name | Type | Description |
---|---|---|
role_id | string required | The role that you plan for the customer manager to have. |
# Sample request
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"
}'
# Response
{
"result": {
"id": 1234,
"user": {
"id": 4321,
"name": "Alex",
"email": "alex@example.com",
"avatar_url": ""
},
"privilege_group": {
"id": 2,
"name": "Admin",
"system": true
}
}
}
# Create a customer manager
Creates a new customer manager in an Embedded partner's account.
POST /api/customer_managers
# Query parameters
Name | Type | Description |
---|---|---|
team_collaborator_id | string required | The collaborator's ID. |
role_id | string required | The role that you plan for the customer manager to have. |
# Sample request
curl -X POST 'https://www.workato.com/api/customer_managers/?team_collaborator_id=1&role_id=1' \
-H 'Authorization: Bearer <api_token>'
# Response
{
"result": {
"id": 1234,
"user": {
"id": 4321,
"name": "Alex",
"email": "alex@example.com",
"avatar_url": ""
},
"privilege_group": {
"id": 1,
"name": "Analyst",
"system": true
}
}
}
# Delete a customer manager
Delete a customer manager from an Embedded partner's account.
DELETE /api/customer_managers/:id
# URL parameters
Name | Type | Description |
---|---|---|
id | string required | The ID of the customer manager. |
# Sample request
curl -X DELETE 'https://www.workato.com/api/customer_managers/1236' \
-H 'Authorization: Bearer <api_token>'
# Response
{
"result": "ok"
}
Last updated: 8/15/2023, 5:07:52 PM