addedInput schema / additionalProperties
Added value: +false
addedInput schema / properties / body
Added value: +{
+ "properties": {
+ "contact_label_ids": {
+ "description": "The Apollo IDs for the labels that you want to include in your search results. If you add multiple labels, Apollo will include all contacts connected to any of the labels, along with the other parameters, in the search results. Example: `['6095a710bd01d100a506d4ae']`",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "contact_stage_ids": {
+ "description": "The Apollo IDs for the contact stages that you want to include in your search results. If you add multiple contact stages, Apollo will include all contacts that match any of the stages, along with the other parameters, in the search results. Call the [list contact stages endpoint](https://docs.apollo.io/reference/list-contact-stages) to retrieve a list of all the contact stage IDs available in your Apollo account. Example: `6095a710bd01d100a506d4ae`",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "page": {
+ "description": "The page number of the Apollo data that you want to retrieve. Use this parameter in combination with the `per_page` parameter to make search results navigable and improve the performance of the endpoint. Example: `4`",
+ "format": "int32",
+ "type": "integer"
+ },
+ "per_page": {
+ "description": "The number of search results that should be returned for each page. Limiting the number of results per page improves the endpoint's performance. Use the `page` parameter to search the different pages of data. Example: `10`",
+ "format": "int32",
+ "type": "integer"
+ },
+ "q_keywords": {
+ "description": "Add a keyword search string to narrow the contacts in your team's Apollo account. Keywords should be related to the same search concept and can include names, job titles, employers or company names, or email addresses. Examples: `matthew helm`; `CEO`; `Sumware Software`",
+ "type": "string"
+ },
+ "sort_ascending": {
+ "default": false,
+ "description": "Set to `true` to sort the matching contacts in ascending order. This parameter must be used with `sort_by_field`. Otherwise, the sorting logic is not applied. Example: `true`",
+ "type": "boolean"
+ },
+ "sort_by_field": {
+ "description": "Sort the matching contacts by 1 of the following options: \n- `contact_last_activity_date`: The most recent activity date recorded first.\n- `contact_email_last_opened_at`: The most recent email opened date first.\n- `contact_email_last_clicked_at`: The most recent email clicked first.\n- `contact_created_at`: The most recently created first.\n- `contact_updated_at`: The most recently updated first.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+}
removedInput schema / properties / contact_label_ids
Removed value: -{
- "description": "Filter by contact label IDs",
- "type": "string"
-}
removedInput schema / properties / contact_stage_ids
Removed value: -{
- "description": "Filter by contact stage IDs",
- "type": "string"
-}
removedInput schema / properties / page
Removed value: -{
- "description": "Page number",
- "type": "integer"
-}
removedInput schema / properties / per_page
Removed value: -{
- "description": "Items per page",
- "type": "integer"
-}
removedInput schema / properties / q_keywords
Removed value: -{
- "description": "Keyword query",
- "type": "string"
-}
removedInput schema / properties / sort_ascending
Removed value: -{
- "description": "Sort ascending. Default false.",
- "type": "boolean"
-}
removedInput schema / properties / sort_by_field
Removed value: -{
- "description": "Sort field (e.g. contact_last_activity_date, contact_created_at, contact_updated_at)",
- "type": "string"
-}
changedInput schema / required
Previous value: -[]New value: +[
+ "body"
+]