Update a smart view

PUT

/api/v1/smart-views/{id}

curl --request PUT \
  --url https://api.pitch2sale.com/api/v1/smart-views/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "query": { "filters": [ { "id": "example", "field": "example", "field_type": "lead", "op": "eq", "value": "example", "activity_type": "example", "activity_field": "example", "activity_field_value": "example" } ], "logic": "AND" }, "sort": { "field": "example", "direction": 1 }, "display_columns": [ "example" ], "visibility": "private" }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

name

string

>= 1 characters <= 200 characters

query

object

filters

required

Array<object>

object

id

required

string

>= 1 characters

field

required

string

>= 1 characters

field_type

required

string

Allowed values: lead contact activity opportunity task custom_field

op

required

string

Allowed values: eq neq gt lt gte lte in nin exists not_exists contains activity_exists activity_not_exists

value

activity_type

string

/^[a-zA-Z0-9_]+$/

activity_field

string

/^[a-zA-Z0-9_.]+$/

activity_field_value

logic

required

string

Allowed values: AND OR

sort

object

field

required

string

>= 1 characters

direction

required

number

Allowed values: 1 -1

display_columns

Array<string>

visibility

string

Allowed values: private team org

Responses

200

OK

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}