POST /api/v2/saved_searches
Creates a saved search for the requesting agent. An agent can have at most 20 saved searches, and names must be unique per agent.
Allowed For
- Agents
Servers
- https://{subdomain}.{domain}.com
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 |
|---|---|---|---|
filters |
String | No |
A JSON-stringified array of filter field IDs to persist alongside the search. Optional. |
query |
String | Yes |
The search query string. Must be 2000 characters or less. |
name |
String | Yes |
The name given by the agent to the saved search. Must be 255 characters or less. |
type |
String | Yes |
The type of object the search applies to Valid values:
|
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.