Macros
Create, update, delete, and query Macros in Zendesk.
Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the 本製品.SELECT * FROM Macros WHERE Id = '123' SELECT * FROM Macros WHERE Active = true SELECT * FROM Macros ORDER BY CreatedAt SELECT * FROM Macros ORDER BY UpdateddAt
You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.
Insert
The Title and Actions fields are required to insert. Allowed for agents.
INSERT INTO Macros (Title, Actions) VALUES ('Roger Wilco II', '[{\"field\": \"status\", \"value": \"solved\"}]')
Update
You must specify the Id of the macro to update. Updating an action updates the containing array, clearing the other actions. Include all your actions when updating any action.Allowed for agents.
UPDATE Macros SET Title = 'Roger Wilco III' WHERE Id = '123'
Delete
You must specify the Id of the macro to delete it. Allowed for agents.
DELETE FROM Macros WHERE Id = '123'
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | Long | False |
Automatically assigned when created. | |
Title | String | False |
The title of the macro. | |
Actions | String | False |
An object describing what the macro will do. | |
Active | Boolean | False |
Useful for determining if the macro should be displayed.Only active macros if true, inactive macros if false. | |
Description | String | False |
The description of the macro. | |
Position | Integer | False |
The position of the macro. | |
Restrictions | String | False |
Who may access this macro. Will be null when everyone in the account can access it. | |
CreatedAt | Datetime | False |
The time the macro was created. | |
UpdatedAt | Datetime | False |
The time of the last update of the macro. | |
Access | String | False |
Only macros with given access. Possible values are personal, shared, or account. | |
Category | String | False |
Only macros within given category. | |
GroupId | Long | False |
Groups.Id |
Only macros belonging to given group. |
OnlyViewable | Boolean | False |
Only macros that can be applied to tickets if true, All macros the current user can manage if false. Defaults to false. | |
Attachments | String | False |
An array of macro attachment IDs to be associated with the macro, used in Insertion |