PUT /api/v2/workspaces/{workspace_id}
Allowed For
- Admins
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
workspace_id |
Integer | Yes |
The id of the workspace |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
workspace |
Object | No | |
workspace.description |
String | No |
User-defined description of this workspace's purpose |
workspace.conditions |
Object | No |
An object that describes the conditions under which the automation will execute. See Conditions reference |
workspace.conditions.any[] |
Array | No |
Logical OR. Tickets may satisfy any of the conditions to be considered matching |
workspace.conditions.any[].field |
String | No |
The name of a ticket field |
workspace.conditions.any[].operator |
String | No |
A comparison operator |
workspace.conditions.any[].value |
String | No |
The value of a ticket field |
workspace.conditions.all[] |
Array | No |
Logical AND. Tickets must fulfill all of the conditions to be considered matching |
workspace.conditions.all[].field |
String | No |
The name of a ticket field |
workspace.conditions.all[].operator |
String | No |
A comparison operator |
workspace.conditions.all[].value |
String | No |
The value of a ticket field |
workspace.macros[] |
Array | No | |
workspace.ticket_form_id |
Number | No | |
workspace.title |
String | No |
The title of the workspace |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.