Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
Embedded API
Resources

Environment management ​

You can use the Environment management endpoints to create, retrieve, update, and delete tags. You can also use these endpoints to monitor user activities in a customer workspace through activity audit log records.

Rate limits ​

Environment management resources have the following rate limit:

Quick reference ​

TypeResourceDescription
GET/api/managed_users/:id/activity_logsRetrieves activity audit log records in a customer workspace.
GET/api/v2/managed_users/:id/tagsRetrieves a list of tags in a customer workspace.
POST/api/v2/managed_users/:id/tagsCreates a tag in a customer workspace.
PUT/api/v2/managed_users/:id/tags/:handleUpdates a tag in a customer workspace.
DELETE/api/v2/managed_users/:id/tags/:handleDeletes a tag in a customer workspace.

Get activity audit log ​

Retrieves detailed information about activities within a specific environment of a customer workspace. You can use query parameters to filter the activity audit log by resource types, such as recipes and connections, or event types, such as creating or deleting recipes.

For a complete list of supported resource and event types, refer to the Activity audit log API reference.

shell
GET /api/managed_users/:id/activity_logs

The response includes two primary elements:

ElementDescription
dataAn array of objects, each representing a log entry. These entries include the event's unique identifier, timestamp, type, and details about the customer workspace, user, and resource involved.
totalThe total number of log entries returned.

Each log entry in the data array contains the following objects:

ObjectDescription
workspaceThis object includes the customer workspace ID, name, email, and environment.

In the Development environment, workspace.name corresponds to the customer's workspace name.

In the Test and Production environments, workspace.name is Environment Test or Environment Production, respectively.
userThis object includes the user ID, name, and email.
detailsThis object provides additional information about the request. The request object contains the IP address and user agent. The activity field describes the specific action performed.
resourceThis object describes the resource involved, including its ID, name, type, email, and email_confirmed_at timestamp if applicable.

USE WORKSPACE ID TO ACCESS DIFFERENT ENVIRONMENT LOGS

You must specify the relevant workspace ID for each environment in the id URL parameter to obtain logs from different customer environments.

URL parameters ​

NameTypeDescription
idstring
required		Embedded customer ID/external ID.
The External ID must be URL encoded and prefixed with an E (for example, EA2300).

Query parameters ​

NameTypeDescription
page[after]integer
optional		Specify the starting point for the next set of results based on the last result of the current page.
page[size]integer
optional		Specify the number of results per page. The default and maximum number of records is 100.
fromstring
optional		Specify the start of the time range for which to retrieve audit logs. Provide in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ).
tostring
optional		Specify the end of the time range for which to retrieve audit logs. Provide in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ).
users_ids[]array of integers
optional		Filter logs to include activities performed by specified user IDs.
include_resource_types[]array of strings
optional		Filter logs to include activities related to specified resource types.
exclude_resource_types[]array of strings
optional		Exclude activities related to specified resource types.
include_event_types[]array of strings
optional		Filter logs to include activities of specified event types.
exclude_event_types[]array of strings
optional		Exclude activities of the specified event types.

TIMEZONE

All data centers use the system timezone, Pacific Daylight Time (PDT). When you specify a timezone in the from and to query parameters, the system converts it to and displays it as PDT.

Sample requests ​

Request 1: Without query parameters ​

The following example request returns a list of all activities for the customer workspace associated with the id URL parameter:

shell
curl  -X GET "https://www.workato.com/api/managed_users/19029/activity_logs" \
      -H "Authorization: Bearer <api_token>"
Response 1: Without query parameters
json
{
    "data": [
        {
            "id": 1234567,
            "timestamp": "2024-06-18 19:17:31 UTC",
            "event_type": "user_login",
            "workspace": {
                "id": 12345,
                "name": "Alex",
                "email": "alex@example.com",
                "environment": "dev"
            },
            "user": {
                "id": 12345,
                "name": "Alex",
                "email": "alex@example.com"
            },
            "details": {
                "request": {
                    "ip_address": "60.160.90.91",
                    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
                },
                "activity": "password_login"
            },
            "resource": {
                "id": 12345,
                "name": "Alex",
                "type": "Workspace",
                "email": "alex@example.com",
                "email_confirmed_at": "2024-04-24 14:23:03 -0700"
            }
        },
        {...}
    ],
    "total": 65
}

Request 2: Get the last three records ​

The following example request retrieves the three most recent activity log entries. This request returns activities for the customer workspace associated with the id URL parameter:

shell
curl  -X GET "https://www.workato.com/api/managed_users/19029/activity_logs?page%5Bsize%5D=3" \
      -H "Authorization: Bearer <api_token>"
Response 2: Get the last three records
json
{
    "data": [
        {
            "id": 3674006,
            "timestamp": "2024-06-26 15:56:07 UTC",
            "event_type": "user_login",
            "workspace": {
                "id": 12345,
                "name": "Alex",
                "email": "alex@example.com",
                "environment": "dev"
            },
            "user": {
                "id": 12345,
                "name": "Alex",
                "email": "alex@example.com"
            },
            "details": {
                "request": {
                    "ip_address": "60.160.90.91",
                    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
                },
                "activity": "password_login"
            },
            "resource": {
                "id": 12345,
                "name": "Alex",
                "type": "Workspace",
                "email": "alex@example.com",
                "email_confirmed_at": "2024-04-24 14:23:03 -0700"
            }
        },
        {
            "id": 3670909,
            "timestamp": "2024-06-25 16:38:11 UTC",
            "event_type": "recipe_created",
            "workspace": {
                "id": 12345,
                "name": "Alex",
                "email": "alex@example.com",
                "environment": "dev"
            },
            "user": {
                "id": 12345,
                "name": "Alex",
                "email": "alex@example.com"
            },
            "details": {
                "request": {
                    "ip_address": "60.160.90.91",
                    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
                }
            },
            "resource": {
                "id": 289287,
                "name": "My new recipe",
                "path": "Home/Demos",
                "type": "Flow",
                "folder_id": 46319
            }
        },
        {
            "id": 3668492,
            "timestamp": "2024-06-24 15:52:23 UTC",
            "event_type": "user_login",
            "workspace": {
                "id": 12345,
                "name": "Alex",
                "email": "alex@example.com",
                "environment": "dev"
            },
            "user": {
                "id": 12345,
                "name": "Alex",
                "email": "alex@example.com"
            },
            "details": {
                "request": {
                    "ip_address": "60.160.90.91",
                    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
                },
                "activity": "password_login"
            },
            "resource": {
                "id": 12345,
                "name": "Alex",
                "type": "Workspace",
                "email": "alex@example.com",
                "email_confirmed_at": "2024-04-24 14:23:03 -0700"
            }
        }
    ],
    "total": 65
}

Request 3: Get the activities of one day for two users ​

The following example request retrieves the activities of two users on June 30, 2024. This request returns activities for the customer workspace associated with the id URL parameter:

shell
curl  -X GET "https://www.workato.com/api/managed_users/19029/activity_logs?from=2024-06-30T00:00:00Z&to=2024-06-30T23:59:59Z&users_ids[]=54321&users_ids[]=12345" \
      -H "Authorization: Bearer <api_token>"

DATE AND TIME FORMAT

Ensure that the from and to query parameters use the YYYY-MM-DD format, in which the month is listed before the day. Using the YYYY-DD-MM format causes a 500 Server error.

Response 3: Get the activities of one day for two users
json
{
    "data": [
        {
            "id": 3649152,
            "timestamp": "2024-06-30 23:09:51 UTC",
            "event_type": "connector_deleted",
            "workspace": {
                "id": 19029,
                "name": "Alex",
                "email": "alex@example.com",
                "environment": "dev"
            },
            "user": {
                "id": 12345,
                "name": "Alex",
                "email": "alex@example.com"
            },
            "details": {
                "request": {
                    "ip_address": "60.160.90.91",
                    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
                }
            },
            "resource": {
                "id": 7321,
                "name": "New Connector 1",
                "type": "CustomAdapter"
            }
        },
        {
            "id": 3649149,
            "timestamp": "2024-06-30 23:07:33 UTC",
            "event_type": "connector_created",
            "workspace": {
                "id": 19029,
                "name": "Alex",
                "email": "alex@example.com",
                "environment": "dev"
            },
            "user": {
                "id": 12345,
                "name": "Alex",
                "email": "alex@example.com"
            },
            "details": {
                "request": {
                    "ip_address": "60.160.90.91",
                    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
                }
            },
            "resource": {
                "id": 7321,
                "name": "New Connector 1",
                "type": "CustomAdapter"
            }
        },
        {
            "id": 3649129,
            "timestamp": "2024-06-30 22:34:36 UTC",
            "event_type": "user_logout",
            "workspace": {
                "id": 19029,
                "name": "Jie",
                "email": "jie@example.com",
                "environment": "dev"
            },
            "user": {
                "id": 54321,
                "name": "Jie",
                "email": "jie@example.com"
            },
            "details": {
                "request": {
                    "ip_address": "192.0.2.1",
                    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
                },
                "activity": "switch_team"
            },
            "resource": {
                "id": 19029,
                "name": "Alex",
                "type": "Workspace",
                "email": "alex@example.com",
                "email_confirmed_at": "2024-04-24 14:23:03 -0700"
            }
        },
        {
            "id": 3649127,
            "timestamp": "2024-06-30 22:32:43 UTC",
            "event_type": "user_login",
            "workspace": {
                "id": 19029,
                "name": "Jie",
                "email": "jie@example.com",
                "environment": "dev"
            },
            "user": {
                "id": 54321,
                "name": "Jie",
                "email": "jie@example.com"
            },
            "details": {
                "request": {
                    "ip_address": "192.0.2.1",
                    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
                },
                "activity": "switch_team"
            },
            "resource": {
                "id": 19029,
                "name": "Alex",
                "type": "Workspace",
                "email": "alex@example.com",
                "email_confirmed_at": "2024-04-24 14:23:03 -0700"
            }
        },
        {
            "id": 3649124,
            "timestamp": "2024-06-30 22:32:16 UTC",
            "event_type": "user_logout",
            "workspace": {
                "id": 19029,
                "name": "Jie",
                "email": "jie@example.com",
                "environment": "dev"
            },
            "user": {
                "id": 54321,
                "name": "Jie",
                "email": "jie@example.com"
            },
            "details": {
                "request": {
                    "ip_address": "192.0.2.1",
                    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
                },
                "activity": "switch_team"
            },
            "resource": {
                "id": 19029,
                "name": "Alex",
                "type": "Workspace",
                "email": "alex@example.com",
                "email_confirmed_at": "2024-04-24 14:23:03 -0700"
            }
        },
        {
            "id": 3649123,
            "timestamp": "2024-06-30 22:32:00 UTC",
            "event_type": "user_login",
            "workspace": {
                "id": 19029,
                "name": "Jie",
                "email": "jie@example.com",
                "environment": "dev"
            },
            "user": {
                "id": 54321,
                "name": "Jie",
                "email": "jie@example.com"
            },
            "details": {
                "request": {
                    "ip_address": "192.0.2.1",
                    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
                },
                "activity": "switch_team"
            },
            "resource": {
                "id": 19029,
                "name": "Alex",
                "type": "Workspace",
                "email": "alex@example.com",
                "email_confirmed_at": "2024-04-24 14:23:03 -0700"
            }
        }
    ],
    "total": 6
}

Request 4: Include activities with specific resource_types and event_types ​

The following example request includes activities with the resource_type ApiPrivilegeGroup and event_type api_privilege_group_updated. This request returns activities for the customer workspace associated with the id URL parameter:

shell
curl  -X GET "https://www.workato.com/api/managed_users/19029/activity_logs?include_resource_types[]=ApiPrivilegeGroup&include_event_types[]=api_privilege_group_updated" \
      -H "Authorization: Bearer <api_token>"
Response 4: Include activities with specific resource_types and event_types
json
{
    "data": [
        {
            "id": 3661175,
            "timestamp": "2024-06-18 17:38:33 UTC",
            "event_type": "api_privilege_group_updated",
            "workspace": {
                "id": 19029,
                "name": "Alex",
                "email": "alex@example.com",
                "environment": "dev"
            },
            "user": {
                "id": 12345,
                "name": "Alex",
                "email": "alex@example.com"
            },
            "details": {
                "request": {
                    "ip_address": "60.160.90.91",
                    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
                }
            },
            "resource": {
                "id": 40327,
                "name": "Recipe Operator",
                "type": "ApiPrivilegeGroup"
            }
        },
        {
            "id": 3644097,
            "timestamp": "2024-06-04 21:37:12 UTC",
            "event_type": "api_privilege_group_updated",
            "workspace": {
                "id": 19029,
                "name": "Alex",
                "email": "alex@example.com",
                "environment": "dev"
            },
            "user": {
                "id": 12345,
                "name": "Alex",
                "email": "alex@example.com"
            },
            "details": {
                "request": {
                    "ip_address": "60.160.90.91",
                    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
                }
            },
            "resource": {
                "id": 40327,
                "name": "Recipe Operator",
                "type": "ApiPrivilegeGroup"
            }
        },
        {
            "id": 3643744,
            "timestamp": "2024-06-04 16:24:44 UTC",
            "event_type": "api_privilege_group_updated",
            "workspace": {
                "id": 19029,
                "name": "Alex",
                "email": "alex@example.com",
                "environment": "dev"
            },
            "user": {
                "id": 12345,
                "name": "Alex",
                "email": "alex@example.com"
            },
            "details": {
                "request": {
                    "ip_address": "60.160.90.91",
                    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
                }
            },
            "resource": {
                "id": 40327,
                "name": "Recipe Operator",
                "type": "ApiPrivilegeGroup"
            }
        }
    ],
    "total": 3
}

Request 5: Exclude activities with specific resource_types and event_types ​

The following example request excludes activities with the resource_type User and event_type user_logout. This request returns activities for the customer workspace associated with the id URL parameter:

shell
curl  -X GET "https://www.workato.com/api/managed_users/19029/activity_logs?exclude_resource_types[]=User&exclude_event_types[]=user_logout" \
      -H "Authorization: Bearer <api_token>"
Response 5: Exclude activities with specific resource_types and event_types
json
{
    "data": [
        {
            "id": 3670909,
            "timestamp": "2024-06-25 16:38:11 UTC",
            "event_type": "recipe_created",
            "workspace": {
                "id": 19029,
                "name": "Alex",
                "email": "alex@example.com",
                "environment": "dev"
            },
            "user": {
                "id": 12345,
                "name": "Alex",
                "email": "alex@example.com"
            },
            "details": {
                "request": {
                    "ip_address": "60.160.90.91",
                    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
                }
            },
            "resource": {
                "id": 289287,
                "name": "My new recipe",
                "path": "Home/Demos",
                "type": "Flow",
                "folder_id": 46319
            }
        },
        {
            "id": 3665078,
            "timestamp": "2024-06-20 20:00:36 UTC",
            "event_type": "connection_updated",
            "workspace": {
                "id": 19029,
                "name": "Alex",
                "email": "alex@example.com",
                "environment": "dev"
            },
            "user": {
                "id": 12345,
                "name": "Alex",
                "email": "alex@example.com"
            },
            "details": {
                "request": {
                    "ip_address": "60.160.90.91",
                    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
                }
            },
            "resource": {
                "id": 66196,
                "name": "My RecipeOps by Workato account",
                "path": "Home/Demos",
                "type": "SharedAccount",
                "provider": "workato_app",
                "folder_id": 46319,
                "authorized": true
            }
        },
        {...}
    ],
    "total": 42
}

Request 6: Get activities with a non-existent event type or customer workspace ID ​

The following example request attempts to retrieve the activities of a non-existent event type and customer workspace ID. Filtering activities by a non-existent event type or customer workspace ID results in an empty array:

shell
curl  -X GET "https://www.workato.com/api/managed_users/19029/activity_logs?users_ids[]=67890&include_event_types[]=nonexistent_event_type" \
      -H "Authorization: Bearer <api_token>"
Response 6: Get activities with a non-existent event type or customer workspace ID
json
{
    "data": [],
    "total": 0
}

List tags ​

Retrieves a list of tags within a customer workspace.

shell
GET /api/v2/managed_users/:id/tags

APPLY OR REMOVE TAGS PROGRAMMATICALLY

Use the Manage tag assignments (POST /api/v2/managed_users/:id/tags_assignments) endpoint to apply or remove asset tags. Taggable assets include recipes and connections.

URL parameters ​

NameTypeDescription
idstring
required		Embedded customer ID/external ID. The External ID must be URL encoded and prefixed with an E (for example, EA2300).

Query parameters ​

NameTypeDescription
pagenumber
optional		The page number of the tags to retrieve. Defaults to 1.
per_pagenumber
optional		The number of tags to return in a single page. Defaults to 100. Maximum value is 100.
q[title_or_description_cont]string
optional		Filters results to include tags where the title or description contains the specified string.

Example: ...?q[title_or_description_cont]=hr
q[handle_in]array of strings
optional		Filters results to include only tags with handles that match the specified values. Each handle must be provided as a separate parameter instance.

Example: ...?q[handle_in][]=tag-APfXzndL-4whAmJ&q[handle_in][]=tag-APfWgxnc-Ggakzt
q[author_id_eq]number
optional		Filters results to include only tags created by the specified author (user ID).

Example: ...?q[author_id_eq]=30482
q[recipe_id_eq]number
optional		Filters results to include only tags associated with the specified recipe ID.

Example: ...?q[recipe_id_eq]=54525313
q[connection_id_eq]number
optional		Filters results to include only tags associated with the specified connection ID.

Example: ...?q[connection_id_eq]=1571346
q[only_assigned]boolean
optional		Filters results to include only tags that are assigned to an asset.

Example: ...?q[only_assigned]=true
sort_by[]array of strings
optional		Specifies fields to sort the response by. Accepts title, assignment_count, updated_at, or last_assigned_at.

Example: ...?sort_by[]=assignment_count
sort_direction[]array of strings
optional		Specifies the sort order for the response. Accepts asc or desc.

Example: ...?sort_direction[]=asc
includes[]array of strings
optional		Specifies additional fields to include in the response. Accepts assignment_count and author.

Example: ...?includes[]=author

This request retrieves a list of tags and uses the includes[] query parameter to return both the author (the user who created the tag) and the number of times the tag has been assigned to an asset.

shell
curl  -X GET "https://www.workato.com/api/v2/managed_users/19029/tags?includes[]=author&includes[]=assignment_count" \
      -H "Authorization: Bearer <api_token>"

Response ​

json
{
  "data": {
    "tags": [
      {
        "handle": "tag-ANgdXgTF-bANz3H",
        "title": "Accounting",
        "description": "Accounting tag",
        "color": "orange",
        "created_at": "2024-08-29T14:09:13-07:00",
        "updated_at": "2024-08-29T14:09:13-07:00",
        "author": {
            "id": 12345,
            "name": "Charlie",
            "avatar_url": ""
        },
        "assignment_count": 6
      },
      {
        "handle": "tag-ANgef8oT-TgTeFY",
        "title": "Business development",
        "description": "Business development tag",
        "color": "green",
        "created_at": "2024-08-29T15:20:44-07:00",
        "updated_at": "2024-08-29T15:20:44-07:00",
        "author": {
            "id": 30482,
            "name": "Jie",
            "avatar_url": ""
        },
        "assignment_count": 3
      },
      {
        "handle": "tag-ANgefFcG-RRkGKc",
        "title": "Finance",
        "description": "Finance tag",
        "color": "gold",
        "created_at": "2024-08-29T15:20:57-07:00",
        "updated_at": "2024-08-29T15:20:57-07:00",
        "author": {
            "id": 73913,
            "name": "Alex",
            "avatar_url": ""
        },
        "assignment_count": 4     
      }
    ]
  }
}

Create a tag ​

Creates a new tag in a customer workspace.

shell
POST /api/v2/managed_users/:id/tags

URL parameters ​

NameTypeDescription
idstring
required		Embedded customer ID/external ID. The External ID must be URL encoded and prefixed with an E (for example, EA2300).

Payload ​

NameTypeDescription
titlestring
required		The title of the tag. Maximum of 30 characters.
descriptionstring
optional		The description of the tag. Maximum of 150 characters.
colorstring
optional		The color of the tag. Accepted values include blue, violet, green, red, orange, gold, indigo, brown, teal, plum, slate, and neutral. If this field is not specified, Workato assigns the tag a random color.

Sample request ​

shell
curl  -X POST "https://www.workato.com/api/v2/managed_users/19029/tags" \
      -H "Authorization: Bearer <api_token>" \
      -H "Content-Type: application/json" \
      -d '{
            "title": "HR",
            "description": "HR tag",
            "color": "green"
          }'

Response ​

json
{
  "data": {
    "handle": "tag-ANrzJTFF-wczhaW",
    "title": "HR",
    "description": "HR tag",
    "color": "green"
  }
}

Update a tag ​

Updates an existing tag in a customer workspace.

shell
PUT /api/v2/managed_users/:id/tags/:handle

URL parameters ​

NameTypeDescription
idstring
required		Embedded customer ID/external ID. The External ID must be URL encoded and prefixed with an E (for example, EA2300).
handlestring
required		The handle of the tag to update.

Payload ​

NameTypeDescription
titlestring
required		The updated tag title. Maximum of 30 characters.
descriptionstring
optional		The updated tag description. Maximum of 150 characters.
colorstring
optional		The updated tag color. Accepted values include blue, violet, green, red, orange, gold, indigo, brown, teal, plum, slate, and neutral.

Sample request ​

shell
curl  -X PUT "https://www.workato.com/api/v2/managed_users/19029/tags/tag-ANrzJTFF-wczhaW" \
      -H "Authorization: Bearer <api_token>" \
      -H "Content-Type: application/json" \
      -d '{
            "title": "Updated tag name",
            "description": "Updated the tag name",
            "color": "red"
          }'

Response ​

json
{
  "data": {
    "handle": "tag-ANrzJTFF-wczhaW",
    "title": "Updated tag name",
    "description": "Updated the tag name",
    "color": "red"
  }
}

Delete a tag ​

Deletes an existing tag in a customer workspace.

shell
DELETE /api/v2/managed_users/:id/tags/:handle

URL parameters ​

NameTypeDescription
idstring
required		Embedded customer ID/external ID. The External ID must be URL encoded and prefixed with an E (for example, EA2300).
handlestring
required		The handle of the tag to delete.

Sample request ​

shell
curl  -X DELETE "https://www.workato.com/api/v2/managed_users/19029/tags/tag-ANrzJTFF-wczhaW" \
      -H "Authorization: Bearer <api_token>"

Response ​

If the request returns a 200 OK status code, the tag was successfully deleted. No content is returned in the response body.

Last updated: