PUT /api/v2/macros/{macro_id}
Allowed For
- Agents
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
macro_id |
Integer | Yes |
The ID of the macro |
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 |
|---|---|---|---|
macro |
Object | No | |
macro.actions[] |
Array | Yes |
Each action describes what the macro will do |
macro.actions[].field |
String | No |
The name of a ticket field to modify |
macro.actions[].value |
String | No |
The new value of the field |
macro.active |
Boolean | No |
Useful for determining if the macro should be displayed |
macro.description |
String | No |
The description of the macro |
macro.restriction |
Object | No |
Who may access this macro. Will be null when everyone in the account can access it |
macro.restriction.id |
Integer | No |
The numeric ID of the group or user |
macro.restriction.type |
String | No |
Allowed values are Group or User |
macro.restriction.ids[] |
Array | No |
The numeric IDs of the groups |
macro.title |
String | Yes |
The title of the macro |
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.