Set a list's filters (replaces them), which score each lead's fit in the table

POSTRequest

curl -X POST "https://prestigious-goldfish-661.convex.site/v1/lists/$ID/criteria" \
    -H "Authorization: Bearer $REACHIZ_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"criteria":[{"id":"<id>","name":"<name>","kind":"filter","description":"<description>","field":"<field>","op":"present"}]}'

Responses

200400401403404409429503

Response 200

Success

application/json

Example responseGenerated from schema

{
  "criteria": [
    {
      "id": "id",
      "name": "name",
      "kind": "filter",
      "description": "description",
      "field": "field",
      "op": "present",
      "value": "value"
    }
  ]
}

Response 400

The request is not valid. error.fields lists each problem.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 401

The API key is missing or not valid.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 403

The key lacks the scope this route needs.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 404

The resource does not exist, or belongs to another account.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 409

The Idempotency-Key belongs to a different request, or the state does not allow this action.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 429

Too many requests.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 503

The service is busy. Retry with backoff.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Path parameters

• idnumberrequired

Request body

Required

Yes

Content type

• application/json

• criteriaobject[]required
  Show array — 7 properties

  • idstringrequired
  • namestringrequired

    Short label, for example Email found

  • kindstringrequired
    Allowed values: filter, info

    filter counts toward the fit score; info is extra data

  • descriptionstringrequired

    What the filter checks, in one sentence

  • fieldstringrequired

    email, phone, position, headline, companyName, companyUrl, location, profileUrl or custom.<name>

  • opstringrequired
    Allowed values: present, contains, equals, gte, lte
  • valuestringoptional

Returns

Schema shown for 200 · application/json

• criteriaobject[]
  Show array — 7 properties

  • idstring
  • namestring

    Short label, for example Email found

  • kindstring
    Allowed values: filter, info

    filter counts toward the fit score; info is extra data

  • descriptionstring

    What the filter checks, in one sentence

  • fieldstring

    email, phone, position, headline, companyName, companyUrl, location, profileUrl or custom.<name>

  • opstring
    Allowed values: present, contains, equals, gte, lte
  • valuestringoptional