Inquirly

Create a custom filter

POST

/api/v1/accounts/{account_id}/custom_filters

Custom Filters

Create a custom filter in the account

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/accounts//custom_filters' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "name": "string",
    "type": "conversation",
    "query": {}
}'

Response Example

200 - Example 1

{
    "id": 0,
    "name": "string",
    "type": "conversation",
    "query": {},
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
}

Request

Path Params

account_id

integer

required

The numeric ID of the account

Body Params application/json; charset=utf-8

name

string

optional

The name of the custom filter

type

enum<string>

optional

The description about the custom filter

Allowed values:

conversationcontactreport

query

object

optional

A query that needs to be saved as a custom filter

Examples

Responses

🟢200OK

application/json; charset=utf-8

Success

Body

number

optional

The ID of the custom filter

name

string

optional

The name of the custom filter

type

enum<string>

optional

The description about the custom filter

Allowed values:

conversationcontactreport

query

object

optional

A query that needs to be saved as a custom filter

created_at

string <date-time>

optional

The time at which the custom filter was created

updated_at

string <date-time>

optional

The time at which the custom filter was updated

🟠401Unauthorized

List all custom filters

Get a custom filter details