Create a Smart View

POST

https://api.close.com/api/v1/saved_search/

POST

/api/v1/saved_search/

curl -X POST https://api.close.com/api/v1/saved_search/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "name": "every lead",
  "s_query": {
    "query": {
      "queries": [
        {
          "object_type": "lead",
          "type": "object_type"
        },
        {
          "condition": {
            "mode": "full_words",
            "type": "text",
            "value": "Bluth Company"
          },
          "field": {
            "field_name": "display_name",
            "object_type": "lead",
            "type": "regular_field"
          },
          "type": "field_condition"
        }
      ],
      "type": "and"
    }
  },
  "type": "lead"
}'

{
  "date_created": "2013-02-01T01:03:56.515000+00:00",
  "date_updated": "2013-02-01T01:03:56.515000+00:00",
  "description": "",
  "id": "save_Cin23B1CYKX83dbNnBB4Q5F5QXl9ucmgrqNf0esq1Ir",
  "is_shared": false,
  "is_user_dependent": false,
  "name": "every lead",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "query": null,
  "s_query": {
    "query": {
      "queries": [
        {
          "object_type": "lead",
          "type": "object_type"
        },
        {
          "condition": {
            "mode": "full_words",
            "type": "text",
            "value": "Bluth Company"
          },
          "field": {
            "field_name": "display_name",
            "object_type": "lead",
            "type": "regular_field"
          },
          "type": "field_condition"
        }
      ],
      "type": "and"
    }
  },
  "type": "lead",
  "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "used_recently": true
}

Create a Lead or Contact Smart View.

For Lead Smart Views, the type field is optional (since lead is the default type).

When creating a Smart View, you must specify that you want to get objects of the appropriate type via an object_type clause as per the Advanced Filtering section. See the examples below.

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects any.

Response

Successful response

date_createddatetime

date_updateddatetime

descriptionstring or null

idstring

is_sharedboolean

is_user_dependentboolean or null

namestring

organization_idstring

querystring or null

s_querymap from strings to any or null

typeenum

user_idstring or null

selected_fieldslist of maps from strings to any or nullOptional

shared_withlist of strings or nullOptional

sharing_settingsobject or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error