{"openapi":"3.1.0","info":{"title":"API Endpoints","version":"1.0.0"},"paths":{"/lead/":{"get":{"operationId":"leads_list","summary":"List Leads","tags":["leads"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/leads_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"leads_create","summary":"Create a new lead","description":"Contacts, addresses, and custom fields can all be nested in the lead. Activities, tasks, and opportunities must be posted separately.\n\n**status / status_id** (optional): Post either `status` or `status_id` (but not both). If neither is provided, the organization's default (first) status will be used. Using `status_id` is recommended so that users can rename statuses in the UI without breaking your implementation.\n\n**custom.FIELD_ID** (optional): Set custom fields by setting `custom.FIELD_ID` to the field value, where FIELD_ID is the ID of the custom field, e.g.:\n\n```json\n{ \"custom.cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c\": \"value\", \"custom.cf_8wtBWsdRU2Fur7GDnEeXQ7ra2Vu7R4hG1SNYdiEhh0F\": \"other value\" }\n```\n\nIf a custom field has `accepts_multiple_values: true`, the entire value will be replaced. For example, given a Lead has a Custom Choice Field with value `[\"A\", \"B\"]`, adding choice `\"C\"` would mean setting the value to `[\"A\", \"B\", \"C\"]`.\n\nNote that using the `custom` field dict or the `custom.FIELD_NAME` syntax (instead of custom field IDs) is deprecated and will be removed from the API. See [Custom Fields](https://developer.close.com/api/resources/custom-fields) for more details.","tags":["leads"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lead"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/lead/merge/":{"post":{"operationId":"leads_merge","summary":"Merge two leads","description":"For details and definitions of 'source' and 'destination', see the Merge Leads feature in the UI.","tags":["leads"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/leads_merge_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/lead/{id}/":{"get":{"operationId":"leads_get","summary":"Get a single Lead","tags":["leads"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lead"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"leads_update","summary":"Update an existing lead","description":"Supports non-destructive patches. Nested `contacts` cannot be updated through this endpoint -- use the Contacts API instead.\n\n**status**: See `status` and `status_id` guidance on the create endpoint.\n\n**custom.FIELD_ID** (optional): See `custom.FIELD_ID` guidance on the create endpoint. You can also unset a single field, e.g.:\n\n```json\n{ \"custom.cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c\": null }\n```\n\nIf the custom field accepts multiple values, you can specify `.add` or `.remove` as part of the field key to add/remove a single value to/from a list of values, e.g.:\n\n```json\n{ \"custom.cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c.add\": \"Wednesday\" }\n```\n\nadds \"Wednesday\" to the list of values which already exist on the given lead.","tags":["leads"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lead"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"leads_delete","summary":"Delete a lead","tags":["leads"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/leads_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/lead/{id}/files/":{"get":{"operationId":"leads_filesList","summary":"List files attached to a lead","tags":["leads"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/leads_filesList_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"leads_filesCreate","summary":"Attach a file to a lead","description":"Attach an already-uploaded file to a lead. First upload the file to S3 using the [Files API](https://developer.close.com/api/resources/files), then pass the resulting download `url` here along with its `filename` and `content_type`.","tags":["leads"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadFile"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLeadFile"}}}},"security":[{"ApiKeyAuth":[]}]}},"/contact/":{"get":{"operationId":"contacts_list","summary":"List contacts","tags":["contacts"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}},{"name":"lead_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contacts_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"contacts_create","summary":"Create a new contact","description":"Contacts belong to exactly one Lead (specified by `lead_id`). If you do not provide a `lead_id` then a new lead will be created, named after the contact.\n\nCustom field values can be set by including `custom.cf_*` keys in the request body, e.g. `\"custom.cf_abc123\": \"value\"`.","tags":["contacts"],"parameters":[{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContact"}}}},"security":[{"ApiKeyAuth":[]}]}},"/contact/{id}/":{"get":{"operationId":"contacts_get","summary":"Fetch a single contact","tags":["contacts"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"contacts_update","summary":"Update an existing contact","description":"Update a contact's information. Custom field values can be set by including `custom.cf_*` keys in the request body, e.g. `\"custom.cf_abc123\": \"value\"`.\n\nFor custom fields that accept multiple values, you can use `.add` or `.remove` suffixes to modify the existing list without replacing it:\n\n```json\n{ \"custom.cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c.add\": \"Wednesday\" }\n```","tags":["contacts"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContact"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"contacts_delete","summary":"Delete a contact","tags":["contacts"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contacts_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/opportunity/":{"get":{"operationId":"opportunities_list","summary":"List or filter opportunities","description":"* All opportunity list responses contain the following aggregate values about all the matching objects (regardless of pagination / limits):\n    * `total_results`: the total number of objects,\n    * `count_by_value_period`: a dictionary containing the number of opportunities by value period, e.g. `{ 'one_time': 2, 'annual': 1, 'monthly': 1 }`,\n    * `total_value_one_time`: the sum of the values of all one time opportunities,\n    * `total_value_monthly`: the sum of the values of all monthly opportunities,\n    * `total_value_annual`: the sum of the values of all annual opportunities,\n    * `total_value_annualized`: the sum of the values of all opportunities where monthly opportunity values are multiplied by 12,\n    * `expected_value_one_time`: the sum of the values of all one time opportunities multiplied by their confidence,\n    * `expected_value_monthly`: the sum of the values of all monthly opportunities multiplied by their confidence,\n    * `expected_value_annual`: the sum of the values of all annual opportunities multiplied by their confidence,\n    * `expected_value_annualized`: the sum of the values of all opportunities multiplied by their confidence where monthly opportunity values are multiplied by 12,\n* `query` is an optional search query filter. Only opportunity properties may be used in the filter. For example, `note:important` will only show opportunities which contain the text `important` in their note. Or, `status_change(old_status:active new_status:won date:yesterday)` will only show opportunities that transitioned from status `active` to status `won` on the previous day.\n* `_order_by` allows: `date_won`, `date_updated`, `date_created`, `confidence`, `user_name`, `value`, `annualized_value`, `annualized_expected_value` (each of them allows descending order by prepending a minus, e.g. `_order_by=-date_won`).\n* `value_period` allows: `one_time`, `monthly`, `annual`.\n* Multiple values for `user_id`, `status_id`, `status_label`, `status_type` and `value_period` can be specified using the *in* operator, e.g. `status_type__in=active,won`.\n* `_group_by` allows: `user_id`, `date_won__week`, `date_won__month`, `date_won__quarter` `date_won__year` to group results by the given criteria.\n\n    When grouping results, the `data` array contains a list of groups instead of objects. A group consists of the following fields:\n    * `key` containing a unique group key,\n    * `objects` containing the list of objects for the given group,\n    * `total_results` containing the number of total objects for the given group,\n    * all aggregate values for the given group,\n    * if grouping by year: `year`, containing the year for the given group,\n    * if grouping by month: `year` and `month`, containing the year and month (1-12) for the given group,\n    * if grouping by quarter: `year` and `quarter`, containing the year and quarter (1-4) for the given group,\n    * if grouping by week: `weekyear` and `week`, containing the ISO week year and ISO week number for the given group,\n    * if grouping by user: `user_id` and `user_name`, containing the user ID and full name of the user for the given group.\n\n    Note that pagination still applies to objects and not groups. The last or first group may be cut off during pagination, therefore `total_results` may not match the length of `objects`. When paginating, the `key` value may be used to combine groups across multiple pages. Sorting using `_order_by` may be applied and sorts the items within each of the groups. Group order can be reversed by prepending a minus. For example,  `_group_by=-date_won__week` will show the most recent weeks first. When grouping by `user_id`, results are ordered by the user's full name.\n* `lead_saved_search_id` is an optional lead Smart View filter.\n* (deprecated) `lead_query` is an optional lead search text-based query filter. This parameter is now deprecated in favor of using the `lead_saved_search_id` Smart View ID parameter.","tags":["opportunities"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}},{"name":"lead_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"user_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"user_id__in","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"status_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"status_id__in","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"status_type","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"status_type__in","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"status_label","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"status_label__in","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"status","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"status__in","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_won","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_won__gte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_won__gt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_won__lte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_won__lt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_created","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_created__gte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_created__gt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_created__lte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_created__lt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_updated","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_updated__gte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_updated__gt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_updated__lte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_updated__lt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"value_period","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"value_period__in","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"query","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"lead_query","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"lead_saved_search_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"is_stalled","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_order_by","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_group_by","in":"query","required":false,"schema":{"type":["string","null"],"default":null}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/opportunities_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"opportunities_create","summary":"Create an opportunity","description":"Create an opportunity, optionally linked to an existing lead.\n\n**custom.FIELD_ID** (optional): Set custom fields by setting `custom.FIELD_ID` to the field value, where FIELD_ID is the ID of the custom field, e.g.:\n\n```json\n{ \"custom.cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c\": \"value\", \"custom.cf_8wtBWsdRU2Fur7GDnEeXQ7ra2Vu7R4hG1SNYdiEhh0F\": \"other value\" }\n```\n\nIf a custom field has `accepts_multiple_values: true`, the entire value will be replaced. For example, given an Opportunity has a Custom Choice Field with value `[\"A\", \"B\"]`, adding choice `\"C\"` would mean setting the value to `[\"A\", \"B\", \"C\"]`.\n\nNote that using the `custom` field dict or the `custom.FIELD_NAME` syntax (instead of custom field IDs) is deprecated and will be removed from the API. See [Custom Fields](https://developer.close.com/api/resources/custom-fields) for more details.","tags":["opportunities"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOpportunity"}}}},"security":[{"ApiKeyAuth":[]}]}},"/opportunity/{id}/":{"get":{"operationId":"opportunities_get","summary":"Retrieve an opportunity","tags":["opportunities"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"opportunities_update","summary":"Update an opportunity","description":"**custom.FIELD_ID** (optional)\n\n- See description for `custom.FIELD_ID` in `POST /opportunity/` above.\n- Additionally, you can unset a single field by using `{ \"custom.FIELD_ID\": null }`, e.g.:\n```\n{ \"custom.cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c\": null }\n```\nIf you're trying to update a custom field and that custom field accepts multiple values, you can also specify `.add` or `.remove` as part of the field key to add/remove a single value to/from a list of values, e.g.:\n```\n{ \"custom.cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c.add\": \"Wednesday\" }\n```","tags":["opportunities"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOpportunity"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"opportunities_delete","summary":"Delete an opportunity","tags":["opportunities"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/opportunities_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/task/":{"get":{"operationId":"tasks_list","summary":"List or filter tasks","description":"The `view` parameter can be used to conveniently access the different task views. It accepts one of the following values:\n\n* `inbox`: Shows incomplete tasks up to the end of the user's day only (taking the time zone into account).\n* `future`: Shows incomplete tasks starting from the user's tomorrow only (taking the time zone into account).\n* `archive`: Shows complete tasks only.\n\nNote that a `view` value of `inbox` or `future` will override any `date__lt` or `date__gte` parameters included in the same request.\n\nThe `_order_by` field allows ordering by `date` or `date_created` (descending order by prepending a minus, e.g. `_order_by=-date`).","tags":["tasks"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"assigned_to","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"format","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"id__in","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"is_complete","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"lead_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_order_by","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type__in","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"view","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date__lt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date__lte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date__gt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date__gte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"due_date","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"due_date__lt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"due_date__lte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"due_date__gt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"due_date__gte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_created__lt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_created__lte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_created__gt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_created__gte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_updated__lt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_updated__lte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_updated__gt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_updated__gte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"tasks_create","summary":"Create a task","description":"Provide the type of task to be created in the `_type` field. Currently only tasks of type `lead` and `outgoing_call` can be created.","tags":["tasks"],"parameters":[{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_create_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTask"}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"tasks_bulkUpdate","summary":"Bulk-update tasks","description":"Any of the filters of the GET endpoint may be used as query parameters or passed in the request body (see [Filter Parameters](https://developer.close.com/api/overview/filter-parameters)). For example:\n\n```json\n{\"_params\": {\"id__in\": \"task_A,task_B,task_C\"}, \"is_complete\": true}\n```\n\nOnly the `assigned_to`, `date` and `is_complete` fields may be updated.","tags":["tasks"],"parameters":[{"name":"assigned_to","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"format","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"id__in","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"is_complete","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"lead_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_order_by","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type__in","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"view","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date__lt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date__lte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date__gt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date__gte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"due_date","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"due_date__lt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"due_date__lte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"due_date__gt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"due_date__gte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_created__lt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_created__lte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_created__gt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_created__gte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_updated__lt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_updated__lte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_updated__gt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_updated__gte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_bulkUpdate_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUpdateNotifications"}}}},"security":[{"ApiKeyAuth":[]}]}},"/task/{id}/":{"get":{"operationId":"tasks_get","summary":"Fetch a task's details","tags":["tasks"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"tasks_update","summary":"Update a task","description":"The `assigned_to`, `date` (either a date or a date-time), and `is_complete` fields may be updated on all tasks. If the task type is `lead`, the `text` field may also be modified.","tags":["tasks"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_update_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNotification"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"tasks_delete","summary":"Delete a task","tags":["tasks"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/files/upload/":{"post":{"operationId":"files_create","summary":"Generate a signed S3 POST","description":"Get the data needed to make a request to S3 to store your file.","tags":["files"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/files_create_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadFile"}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_object/":{"get":{"operationId":"customObjects_list","summary":"List Custom Object instances","description":"The `lead_id` parameter is required. If you want to retrieve all Custom Object instances regardless of the lead, you will need to use [Advanced Filtering](https://developer.close.com/api/resources/advanced-filtering).\n\nCustom Fields values appear in the format: `custom.{custom_field_id}`. See [Custom Fields](https://developer.close.com/api/resources/custom-fields/custom-fields-custom-object).\n\nBack references to each Custom Object are not collected in this response. If you need to access this information, please use the `back_reference_fields` on the Custom Object Type and [Advanced Filtering](https://developer.close.com/api/resources/advanced-filtering) to search for objects that reference the Custom Object Instance.","tags":["custom_objects"],"parameters":[{"name":"lead_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"custom_object_type_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_objects_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"customObjects_create","summary":"Create a new Custom Object instance","description":"Custom Field values can be set using the format: `custom.{custom_field_id}`. See [Custom Fields](https://developer.close.com/api/resources/custom-fields/custom-fields-custom-object).\n\nThe following fields are required:\n  - `custom_object_type_id`: The type of Custom Object you are creating determines the Custom Fields that can be used.\n  - `lead_id`: The Lead that this Custom Object instance will belong to.\n  - `name`: Each Custom Object has a name, used for display.","tags":["custom_objects"],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_objects_create_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_object/{id}/":{"get":{"operationId":"customObjects_get","summary":"Retrieve a single Custom Object instance","tags":["custom_objects"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_objects_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"customObjects_update","summary":"Updating a Custom Object instance","description":"A Custom Object can be updated to add, change or remove any Custom Fields, and to change the `name` property.","tags":["custom_objects"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_objects_update_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"customObjects_delete","summary":"Delete a Custom Object instance","tags":["custom_objects"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/comment/":{"get":{"operationId":"comments_list","summary":"Fetch multiple comments","description":"Comments may be fetched by `object_id` (the object that was commented on) or by `thread_id`. Exactly one of those filters must be provided.\n\nComments on leads the requestor cannot see are omitted from the response.","tags":["comments"],"parameters":[{"name":"thread_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"object_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/comments_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"comments_create","summary":"Create a Comment","description":"Create a comment on an object. If a comment thread already exists on that object, a new comment is added to the existing thread. If no thread exists yet, one is created automatically.","tags":["comments"],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/comments_create_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateComment"}}}},"security":[{"ApiKeyAuth":[]}]}},"/comment/{id}/":{"get":{"operationId":"comments_get","summary":"Fetch an individual comment","description":"A `404` is returned both when the comment does not exist and when the requestor cannot see its lead.","tags":["comments"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/comments_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"comments_update","summary":"Update a Comment","description":"You can use this endpoint to edit a comment body. Note that users may only update their own comments.","tags":["comments"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/comments_update_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommentThreads"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"comments_delete","summary":"Remove a comment","description":"Note that contrary to the HTTP verb, this does not necessarily _delete_ a comment (but it will _remove_ it). Comments bodies are removed, but the comment object still exists until all comments in a thread are removed (at which point the entire thread is deleted).\n\nPermissions around removing comments inherit from the users permission to delete their own or other users' activities.","tags":["comments"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/comment_thread/":{"get":{"operationId":"comments_listThreads","summary":"Fetch multiple comment threads","description":"Users with restricted lead visibility cannot list comment threads across all leads, and must scope the request to specific threads or objects via the `ids` or `object_ids` filters. Unscoped requests from such users return a `403`.","tags":["comments"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"ids","in":"query","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"object_ids","in":"query","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/comments_listThreads_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The requestor has restricted lead visibility and did not scope the request by `ids` or `object_ids`.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/comment_thread/{id}/":{"get":{"operationId":"comments_getThread","summary":"Fetch an individual comment thread","description":"A `404` is returned both when the comment thread does not exist and when the requestor cannot see its lead.","tags":["comments"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/comments_getThread_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/":{"get":{"operationId":"activities_list","summary":"List or filter all activity types","description":"To list only a specific activity type (e.g., only `Call` or `LeadStatusChange`), use the other resources listed separately. When querying activities for a single lead (using the `lead_id` parameter), you can ask for multiple activity types using `_type__in`.\n\nWhen listing [Custom Activities](https://developer.close.com/api/resources/activities/custom-activities), `_type` and `_type__in` can include Custom Activity Type ids (e.g. `actitype_1h5m6uHM9BZOpwVhyRJb4Y`) to filter by a specific custom activity type or `Custom` to list custom activities of any type.\n\nThe following filtering parameters can only be used for listing activities on a single lead (using the `lead_id` parameter): `user_id`, `user_id__in`, `contact_id`, `contact_id__in`, `_type`, `_type__in`.\n\nAll activities have two sortable datetime fields: `date_created` and `activity_at`. `date_created` denotes when an activity was created or synced into Close and `activity_at` denotes when that activity actually occurred. For example, on outgoing Email activities, `date_created` is equal to when the email was first created in Close, and `activity_at` is equal to when the email was actually sent. For Meeting activities, `activity_at` is equal to the scheduled time of the meeting. On custom activities, users are able to update the `activity_at` field at any time.\n\nSorting by `-activity_at` can only be used when listing activities on a single lead using the `lead_id` parameter. In addition, you can only use the date-based filters of the field you're currently sorting on. This means that if you want to use `activity_at__lt` and `activity_at__gt` as filters, you need to include `_order_by=-activity_at` in your request.\n\n`thread_emails` parameter:\n\n - (Default) when this parameter is not present, `Email` objects will be returned for each email message.\n - A value of `true` will return `EmailThread` objects representing email conversations. Stripped-down version of `Email` objects will also be returned.\n - A value of `only` will return `EmailThread` objects representing email conversations. `Email` objects will not be returned.","tags":["activities"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"id__in","in":"query","description":"Filter by activity IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"lead_id","in":"query","description":"Filter by lead IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"contact_id","in":"query","description":"Filter by contact IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"user_id","in":"query","description":"Filter by user IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type","in":"query","description":"Filter by activity type, e.g. Call (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"date_created__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityGetParametersDateCreatedGte"}},{"name":"date_created__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityGetParametersDateCreatedLte"}},{"name":"date_created__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityGetParametersDateCreatedGt"}},{"name":"date_created__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityGetParametersDateCreatedLt"}},{"name":"activity_at__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityGetParametersActivityAtGte"}},{"name":"activity_at__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityGetParametersActivityAtLte"}},{"name":"activity_at__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityGetParametersActivityAtGt"}},{"name":"activity_at__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityGetParametersActivityAtLt"}},{"name":"lead_id__in","in":"query","required":false,"schema":{"type":"string"}},{"name":"user_id__in","in":"query","required":false,"schema":{"type":"string"}},{"name":"contact_id__in","in":"query","required":false,"schema":{"type":"string"}},{"name":"_type__in","in":"query","required":false,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}},{"name":"_order_by","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/note/":{"get":{"operationId":"activitiesNotes_list","summary":"List or filter all Note activities","tags":["activities.notes"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"id__in","in":"query","description":"Filter by activity IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"lead_id","in":"query","description":"Filter by lead IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"contact_id","in":"query","description":"Filter by contact IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"user_id","in":"query","description":"Filter by user IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type","in":"query","description":"Filter by activity type, e.g. Call (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"date_created__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityNoteGetParametersDateCreatedGte"}},{"name":"date_created__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityNoteGetParametersDateCreatedLte"}},{"name":"date_created__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityNoteGetParametersDateCreatedGt"}},{"name":"date_created__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityNoteGetParametersDateCreatedLt"}},{"name":"activity_at__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityNoteGetParametersActivityAtGte"}},{"name":"activity_at__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityNoteGetParametersActivityAtLte"}},{"name":"activity_at__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityNoteGetParametersActivityAtGt"}},{"name":"activity_at__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityNoteGetParametersActivityAtLt"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.notes_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"activitiesNotes_create","summary":"Create a Note activity","description":"To include an attachment, you must first upload the file to Close using the [Files API](https://developer.close.com/api/resources/files). Then, add an object to the `attachments` array with the following fields: `url`, `filename` and `content_type`. The `url` should be the URL provided in the `download.url` field of the response from the [Files API](https://developer.close.com/api/resources/files). It must begin `https://app.close.com/go/file/`.\n\nA note can be pinned or unpinned by setting the `pinned` field to `true` or `false` when creating or updating a note.","tags":["activities.notes"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityBase"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNoteActivity"}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/note/{id}/":{"get":{"operationId":"activitiesNotes_get","summary":"Get a single Note activity","tags":["activities.notes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityBase"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"activitiesNotes_update","summary":"Update a Note activity","description":"**`note_html` and `note`**: setting one overwrites the other. If both are provided, `note_html` takes precedence. `note_html` supports rich-text HTML; `note` is plaintext only.\n\nA note can be pinned or unpinned by setting `pinned` to `true` or `false`.","tags":["activities.notes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityBase"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNoteActivity"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"activitiesNotes_delete","summary":"Delete a Note activity","tags":["activities.notes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.notes_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/call/":{"get":{"operationId":"activitiesCalls_list","summary":"List or filter all Call activities","tags":["activities.calls"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"id__in","in":"query","description":"Filter by activity IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"lead_id","in":"query","description":"Filter by lead IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"contact_id","in":"query","description":"Filter by contact IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"user_id","in":"query","description":"Filter by user IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type","in":"query","description":"Filter by activity type, e.g. Call (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"date_created__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCallGetParametersDateCreatedGte"}},{"name":"date_created__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCallGetParametersDateCreatedLte"}},{"name":"date_created__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCallGetParametersDateCreatedGt"}},{"name":"date_created__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCallGetParametersDateCreatedLt"}},{"name":"activity_at__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCallGetParametersActivityAtGte"}},{"name":"activity_at__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCallGetParametersActivityAtLte"}},{"name":"activity_at__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCallGetParametersActivityAtGt"}},{"name":"activity_at__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCallGetParametersActivityAtLt"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.calls_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"activitiesCalls_create","summary":"Log an external Call activity","description":"Use this endpoint to log calls made outside of the Close built-in VoIP system.\n\n*status*: defaults to `completed`\n\n*direction* (optional): `outbound` or `inbound`\n\n*recording_url*: you can post a URL pointing to the MP3 recording of your call. For security reasons, we require the URL to be secure (i.e. starting with https://)","tags":["activities.calls"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallActivity"}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/call/{id}/":{"get":{"operationId":"activitiesCalls_get","summary":"Get a single Call activity","tags":["activities.calls"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"activitiesCalls_update","summary":"Update a Call activity","description":"Most commonly used to update `note_html` or `outcome_id`. Some fields (`status`, `duration`, `direction`) cannot be updated for internal calls made through Close's VoIP system.\n\n**`note_html` and `note`**: setting one overwrites the other. If both are provided, `note_html` takes precedence. `note_html` supports rich-text HTML; `note` is plaintext only.\n\n**Deleting recordings**: for internal calls, changing or clearing `recording_url` or `voicemail_url`, or setting `recording_transcript` to `null`, permanently deletes the corresponding recording, voicemail, or transcript. This requires the `delete_own_activities` permission for your own calls, or `manage_others_activities` for other users' calls and calls not assigned to a user. Without the required permission the request fails with a `400` error.","tags":["activities.calls"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallActivity"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"activitiesCalls_delete","summary":"Delete a Call activity","tags":["activities.calls"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.calls_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/email/":{"get":{"operationId":"activitiesEmails_list","summary":"List or filter all Email activities","description":"You'll get one object per email message.","tags":["activities.emails"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"id__in","in":"query","description":"Filter by activity IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"lead_id","in":"query","description":"Filter by lead IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"contact_id","in":"query","description":"Filter by contact IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"user_id","in":"query","description":"Filter by user IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type","in":"query","description":"Filter by activity type, e.g. Call (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"date_created__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityEmailGetParametersDateCreatedGte"}},{"name":"date_created__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityEmailGetParametersDateCreatedLte"}},{"name":"date_created__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityEmailGetParametersDateCreatedGt"}},{"name":"date_created__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityEmailGetParametersDateCreatedLt"}},{"name":"activity_at__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityEmailGetParametersActivityAtGte"}},{"name":"activity_at__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityEmailGetParametersActivityAtLte"}},{"name":"activity_at__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityEmailGetParametersActivityAtGt"}},{"name":"activity_at__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityEmailGetParametersActivityAtLt"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.emails_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"activitiesEmails_create","summary":"Create an Email activity","description":"*status* must be one of the following:\n\n - `inbox` to log an already received email.\n - `draft` to create a draft email.\n - `scheduled` to send an email at a scheduled date and time, which must be specified in the `date_scheduled` field.\n - `outbox` to actually **send** an email. To delay email sending by a few seconds (to allow undo), specify `send_in` in seconds (must be less than 60).\n - `sent` to log an already sent email.\n\nOnly drafts can be modified, and their status can be changed to `scheduled` (to send later) or `outbox` (to send immediately). Scheduled emails, or emails in outbox that weren't sent yet can be canceled by setting the status back to `draft`.\n\nFor scheduled, outbox, or sent emails, a `followup_date` may be posted, which will have Close create an email followup task if no response was received.\n\nWe'll render an Email Template server-side if you include a `template_id` _without_ including `body_text` or `body_html` in your POST.\n\nTo specify both a sender name and a sender email address when posting an email, you can use the `sender` field with the format `\"sender\": \"\"John Smith\" <emailaddress@example.com>\"`\n\nThe `sender` field is **required** for emails with status `inbox`, `scheduled`, `outbox`, or `error`. It may be omitted for `draft` (since the sender can be specified later before sending) and `sent` (where it defaults to the email address of the `user` associated with the email or the owner of the API key).\n\nTo include an attachment, you must first upload the file to Close using the [Files API](https://developer.close.com/api/resources/files). Then, add an object to the `attachments` array with the following fields: `url`, `filename`, `content_type`, and `size`. The `url` should be the URL provided in the `download.url` field of the response from the [Files API](https://developer.close.com/api/resources/files). It must begin `https://app.close.com/go/file/`.","tags":["activities.emails"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEmailActivity"}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/email/{id}/":{"get":{"operationId":"activitiesEmails_get","summary":"Get a single Email activity","tags":["activities.emails"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"activitiesEmails_update","summary":"Update an Email activity","description":"This can be used to modify a draft or send it once the draft is complete.\n\nWhen changing a draft's status to `scheduled` or `outbox`, the `sender` field is required if not already set on the email.","tags":["activities.emails"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEmailActivity"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"activitiesEmails_delete","summary":"Delete an Email activity","tags":["activities.emails"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.emails_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/emailthread/":{"get":{"operationId":"activitiesEmailThreads_list","summary":"List or filter all EmailThread activities","description":"You'll get one object per email conversation (generally grouped by subject).","tags":["activities.email_threads"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"id__in","in":"query","description":"Filter by activity IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"lead_id","in":"query","description":"Filter by lead IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"contact_id","in":"query","description":"Filter by contact IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"user_id","in":"query","description":"Filter by user IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type","in":"query","description":"Filter by activity type, e.g. Call (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"date_created__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityEmailthreadGetParametersDateCreatedGte"}},{"name":"date_created__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityEmailthreadGetParametersDateCreatedLte"}},{"name":"date_created__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityEmailthreadGetParametersDateCreatedGt"}},{"name":"date_created__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityEmailthreadGetParametersDateCreatedLt"}},{"name":"activity_at__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityEmailthreadGetParametersActivityAtGte"}},{"name":"activity_at__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityEmailthreadGetParametersActivityAtLte"}},{"name":"activity_at__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityEmailthreadGetParametersActivityAtGt"}},{"name":"activity_at__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityEmailthreadGetParametersActivityAtLt"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.email_threads_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/emailthread/{id}/":{"get":{"operationId":"activitiesEmailThreads_get","summary":"Get a single EmailThread activity","tags":["activities.email_threads"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailThreadActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"activitiesEmailThreads_delete","summary":"Delete an EmailThread activity","description":"This will also delete all the email activities belonging to this thread.","tags":["activities.email_threads"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.email_threads_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/sms/":{"get":{"operationId":"activitiesSms_list","summary":"List or filter all SMS activities","description":"Get a list of matching SMS activities.\n\nMMS messages are considered SMS messages with attachments. Attachments have identical fields to email attachments (`url`, `filename`, `size` and `content_type`), a `media_id` uniquely identifying an attachment, and if Close was able to generate a thumbnail, a `thumbnail_url` too.\n\nAccessing `url` or `thumbnail_url` requires an authenticated session and leads to a temporarily signed S3 URL.","tags":["activities.sms"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"id__in","in":"query","description":"Filter by activity IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"lead_id","in":"query","description":"Filter by lead IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"contact_id","in":"query","description":"Filter by contact IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"user_id","in":"query","description":"Filter by user IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type","in":"query","description":"Filter by activity type, e.g. Call (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"date_created__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivitySmsGetParametersDateCreatedGte"}},{"name":"date_created__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivitySmsGetParametersDateCreatedLte"}},{"name":"date_created__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivitySmsGetParametersDateCreatedGt"}},{"name":"date_created__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivitySmsGetParametersDateCreatedLt"}},{"name":"activity_at__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivitySmsGetParametersActivityAtGte"}},{"name":"activity_at__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivitySmsGetParametersActivityAtLte"}},{"name":"activity_at__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivitySmsGetParametersActivityAtGt"}},{"name":"activity_at__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivitySmsGetParametersActivityAtLt"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.sms_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"activitiesSms_create","summary":"Create an SMS activity","description":"*status* must be one of the following:\n\n - `inbox` to log an already received SMS.\n - `draft` to create a draft SMS.\n - `scheduled` to send an SMS at a scheduled date and time, which must be specified in the `date_scheduled` field.\n - `outbox` to actually **send** an SMS. To delay SMS sending by a few seconds (to allow undo), specify `send_in` in seconds (must be less than 60).\n - `sent` to log an already sent SMS.\n\nOnly drafts can be modified, and their status can be changed to `scheduled` (to send later) or `outbox` (to send immediately). Scheduled SMS, or SMS in outbox that weren't sent yet can be canceled by setting the status back to `draft`.\n\nYou have to provide a `local_phone` that will be used to send the SMS. The number you choose has to be associated with a Phone Number of type `internal`. See the [Phone Numbers](https://developer.close.com/api/resources/phone-numbers) paragraph for more details.\n\nA `template_id` referencing an SMS Template may be provided instead of `text` to automatically render that template and use the content as `text`.\n\nWhen `direction` is not provided, but `status=\"inbox\"`, `direction` will default to \"inbound\". Otherwise, `direction` defaults to \"outbound\".\n\nWhen creating a new SMS with the status set to `inbox`, you can pass the query parameter `send_to_inbox` with the value of `true`  to create a corresponding Inbox Notification for the SMS.","tags":["activities.sms"],"parameters":[{"name":"send_to_inbox","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SMSActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSMSActivity"}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/sms/{id}/":{"get":{"operationId":"activitiesSms_get","summary":"Get a single SMS activity","tags":["activities.sms"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SMSActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"activitiesSms_update","summary":"Update an SMS activity","description":"This can be used to modify a draft or send it once the draft is complete.\n\nTo send an SMS immediately, you can update its `status` to `outbox`. To send it at a later time, change the `status` to `scheduled` and provide the desired date & time in the `date_scheduled` field.","tags":["activities.sms"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SMSActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSMSActivity"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"activitiesSms_delete","summary":"Delete an SMS activity","tags":["activities.sms"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.sms_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/whatsapp_message/":{"get":{"operationId":"activitiesWhatsappMessages_list","summary":"List or filter all WhatsAppMessage activities","description":"Filter by `external_whatsapp_message_id` to find messages to update or delete based on changes in WhatsApp.","tags":["activities.whatsapp_messages"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"id__in","in":"query","description":"Filter by activity IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"lead_id","in":"query","description":"Filter by lead IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"contact_id","in":"query","description":"Filter by contact IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"user_id","in":"query","description":"Filter by user IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type","in":"query","description":"Filter by activity type, e.g. Call (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"date_created__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityWhatsappMessageGetParametersDateCreatedGte"}},{"name":"date_created__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityWhatsappMessageGetParametersDateCreatedLte"}},{"name":"date_created__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityWhatsappMessageGetParametersDateCreatedGt"}},{"name":"date_created__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityWhatsappMessageGetParametersDateCreatedLt"}},{"name":"activity_at__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityWhatsappMessageGetParametersActivityAtGte"}},{"name":"activity_at__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityWhatsappMessageGetParametersActivityAtLte"}},{"name":"activity_at__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityWhatsappMessageGetParametersActivityAtGt"}},{"name":"activity_at__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityWhatsappMessageGetParametersActivityAtLt"}},{"name":"external_whatsapp_message_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.whatsapp_messages_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"activitiesWhatsappMessages_create","summary":"Create a WhatsAppMessage activity","description":"`external_whatsapp_message_id` must be the ID of the message inside WhatsApp. You can filter by this field to find messages in Close to update or delete based on updates or deletions in WhatsApp.\n\n`message_markdown` must be the body of the message in the WhatsApp Markdown format. The `message_html` read-only field will return the HTML representation of this message.\n\nTo include an attachment, you must first upload the file to Close using the [Files API](https://developer.close.com/api/resources/files). Then, add an object to the `attachments` array with the following fields: `url`, `filename`, and `content_type`. The `url` should be the URL provided in the `download.url` field of the response from the [Files API](https://developer.close.com/api/resources/files). It must begin with `https://app.close.com/go/file/`.\n\n`integration_link` (optional) is a URL string that can be provided by the integration partner creating the WhatsApp message. This can be used to link back to the message in the external system.\n\n`response_to_id` (optional) is the Close activity ID of another WhatsApp message activity (not the WhatsApp native message ID) that this message is replying to. This field creates a thread relationship between messages, allowing you to track conversation flow and message replies within WhatsApp threads. The ID must be a valid WhatsApp message activity ID in Close (e.g., `acti_...`).\n\nOnly WhatsApp Markdown messages and file attachments are supported. No support is provided for Polls, Events, Locations, etc.\n\n**Important**: The total size of all attachments for a single WhatsApp message activity cannot exceed 25MB.\n\nWhen creating a new WhatsApp message with the direction set to `incoming`, you can pass the query parameter `send_to_inbox` with the value of `true` to create a corresponding Inbox Notification for the message.","tags":["activities.whatsapp_messages"],"parameters":[{"name":"send_to_inbox","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppMessageActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWhatsAppMessage"}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/whatsapp_message/{id}/":{"get":{"operationId":"activitiesWhatsappMessages_get","summary":"Get a single WhatsAppMessage activity","tags":["activities.whatsapp_messages"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppMessageActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"activitiesWhatsappMessages_update","summary":"Update a WhatsAppMessage activity","tags":["activities.whatsapp_messages"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhatsAppMessageActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWhatsAppMessage"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"activitiesWhatsappMessages_delete","summary":"Delete a WhatsAppMessage activity","tags":["activities.whatsapp_messages"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.whatsapp_messages_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/meeting/":{"get":{"operationId":"activitiesMeetings_list","summary":"List or filter all Meeting activities","tags":["activities.meetings"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"id__in","in":"query","description":"Filter by activity IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"lead_id","in":"query","description":"Filter by lead IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"contact_id","in":"query","description":"Filter by contact IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"user_id","in":"query","description":"Filter by user IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type","in":"query","description":"Filter by activity type, e.g. Call (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"date_created__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityMeetingGetParametersDateCreatedGte"}},{"name":"date_created__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityMeetingGetParametersDateCreatedLte"}},{"name":"date_created__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityMeetingGetParametersDateCreatedGt"}},{"name":"date_created__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityMeetingGetParametersDateCreatedLt"}},{"name":"activity_at__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityMeetingGetParametersActivityAtGte"}},{"name":"activity_at__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityMeetingGetParametersActivityAtLte"}},{"name":"activity_at__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityMeetingGetParametersActivityAtGt"}},{"name":"activity_at__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityMeetingGetParametersActivityAtLt"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.meetings_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/meeting/{id}/":{"get":{"operationId":"activitiesMeetings_get","summary":"Get a single Meeting activity","description":"Meeting transcripts can be accessed using this API but are not loaded by default. To load transcripts, use the `_fields` parameter with `transcripts` value.\n\nThe `transcripts` field is an array of objects for each Close Notetaker bot that joined the meeting. Typically, there will be only one transcript. Transcripts are ordered by the time bots joined the meeting.\n\nExample transcripts in response:\n\n```json\n{ \"transcripts\": [ { \"utterances\": [ { \"speaker_label\": \"John Lead\", \"speaker_side\": \"contact\", \"start\": 0.1, \"end\": 1.2, \"text\": \"Hey, what's up? How is it going?\" }, { \"speaker_label\": \"Jane User\", \"speaker_side\": \"close-user\", \"start\": 1.3, \"end\": 2.4, \"text\": \"Hey John, I'm doing great. How about you?\" } ], \"summary_text\": \"Summary text\", \"summary_html\": \"<p>Summary text</p>\" } ] }\n```","tags":["activities.meetings"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeetingActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"activitiesMeetings_update","summary":"Update a Meeting activity","description":"Most commonly this can be used to update a meetings's `user_note_html` or `outcome_id`.","tags":["activities.meetings"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeetingActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"activitiesMeetings_delete","summary":"Delete a Meeting activity","tags":["activities.meetings"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.meetings_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/meeting/{id}/integration/":{"post":{"operationId":"activitiesMeetings_createIntegration","summary":"Create or update third-party Meeting integration","description":"Please note that only OAuth apps can perform this operation. Using API key will result in an error. See [Authentication with OAuth](https://developer.close.com/api/overview/oauth-authentication) for more information.\n\nThird party integrations are presented as tabs titled with OAuth app name in the activity feed. When invoked for the first time with a given OAuth app a new integration is created, subsequent calls with the same OAuth app will update an existing integration. Submitting an empty JSON body does nothing.","tags":["activities.meetings"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.meetings_createIntegration_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/custom/":{"get":{"operationId":"activitiesCustomActivities_list","summary":"List or filter all Custom Activity instances","description":"Custom Fields appear in the format: `custom.{custom_field_id}`. See [Custom Fields](https://developer.close.com/api/resources/custom-fields/custom-fields-activity).\n\nIf you're filtering by `custom_activity_type_id` or `custom_activity_type_id__in` parameter, the `lead_id` parameter will be required as well. If you want to retrieve all Custom Activity instances of a specific type regardless of the lead, you will need to get leads that contain such an activity type using [Advanced Filtering](https://developer.close.com/api/resources/advanced-filtering) and provide those Lead IDs one at a time to this endpoint.","tags":["activities.custom_activities"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"id__in","in":"query","description":"Filter by activity IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"lead_id","in":"query","description":"Filter by lead IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"contact_id","in":"query","description":"Filter by contact IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"user_id","in":"query","description":"Filter by user IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type","in":"query","description":"Filter by activity type, e.g. Call (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"date_created__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCustomGetParametersDateCreatedGte"}},{"name":"date_created__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCustomGetParametersDateCreatedLte"}},{"name":"date_created__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCustomGetParametersDateCreatedGt"}},{"name":"date_created__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCustomGetParametersDateCreatedLt"}},{"name":"activity_at__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCustomGetParametersActivityAtGte"}},{"name":"activity_at__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCustomGetParametersActivityAtLte"}},{"name":"activity_at__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCustomGetParametersActivityAtGt"}},{"name":"activity_at__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCustomGetParametersActivityAtLt"}},{"name":"custom_activity_type_id","in":"query","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"custom_activity_type_id__in","in":"query","required":false,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.custom_activities_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"activitiesCustomActivities_create","summary":"Create a new Custom Activity instance","description":"Custom Activity instances will be created by default with the 'published' status. All required fields will be validated in this status. To create an activity without setting all required fields, you can use the \"draft\" status.\n\nA Custom Activity can be pinned or unpinned by setting the `pinned` field to `true` or `false` when creating or updating a Custom Activity.\n\nCustom Fields appear in the format: `custom.{custom_field_id}`. See [Custom Fields](https://developer.close.com/api/resources/custom-fields/custom-fields-activity).","tags":["activities.custom_activities"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomActivity"}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/custom/{id}/":{"get":{"operationId":"activitiesCustomActivities_get","summary":"Get a single Custom Activity instance","description":"Custom Fields appear in the format: `custom.{custom_field_id}`. See [Custom Fields](https://developer.close.com/api/resources/custom-fields/custom-fields-activity).","tags":["activities.custom_activities"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"activitiesCustomActivities_update","summary":"Updating a Custom Activity instance","description":"A Custom Activity can be updated to add, change or remove any Custom Fields and to change the status between \"draft\" and \"published\".\n\nA Custom Activity can be pinned or unpinned by setting the `pinned` field to `true` or `false` when creating or updating a Custom Activity.\n\nCustom Fields appear in the format: `custom.{custom_field_id}`. See [Custom Fields](https://developer.close.com/api/resources/custom-fields/custom-fields-activity).","tags":["activities.custom_activities"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomActivity"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"activitiesCustomActivities_delete","summary":"Delete a Custom Activity instance","tags":["activities.custom_activities"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.custom_activities_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/created/":{"get":{"operationId":"activitiesCreations_list","summary":"List or filter all Created activities","tags":["activities.creations"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"id__in","in":"query","description":"Filter by activity IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"lead_id","in":"query","description":"Filter by lead IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"contact_id","in":"query","description":"Filter by contact IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"user_id","in":"query","description":"Filter by user IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type","in":"query","description":"Filter by activity type, e.g. Call (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"date_created__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCreatedGetParametersDateCreatedGte"}},{"name":"date_created__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCreatedGetParametersDateCreatedLte"}},{"name":"date_created__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCreatedGetParametersDateCreatedGt"}},{"name":"date_created__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCreatedGetParametersDateCreatedLt"}},{"name":"activity_at__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCreatedGetParametersActivityAtGte"}},{"name":"activity_at__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCreatedGetParametersActivityAtLte"}},{"name":"activity_at__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCreatedGetParametersActivityAtGt"}},{"name":"activity_at__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityCreatedGetParametersActivityAtLt"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.creations_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/created/{id}/":{"get":{"operationId":"activitiesCreations_get","summary":"Get a single Created activity","tags":["activities.creations"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/form_submission/":{"get":{"operationId":"activitiesFormSubmissions_list","summary":"List or filter all FormSubmission activities","description":"Get a list of matching FormSubmission activities. In addition to standard Activity filtering parameters, you can filter by specific form(s) using the `form_id` or `form_id__in` parameters.","tags":["activities.form_submissions"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"id__in","in":"query","description":"Filter by activity IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"lead_id","in":"query","description":"Filter by lead IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"contact_id","in":"query","description":"Filter by contact IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"user_id","in":"query","description":"Filter by user IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type","in":"query","description":"Filter by activity type, e.g. Call (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"date_created__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityFormSubmissionGetParametersDateCreatedGte"}},{"name":"date_created__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityFormSubmissionGetParametersDateCreatedLte"}},{"name":"date_created__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityFormSubmissionGetParametersDateCreatedGt"}},{"name":"date_created__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityFormSubmissionGetParametersDateCreatedLt"}},{"name":"activity_at__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityFormSubmissionGetParametersActivityAtGte"}},{"name":"activity_at__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityFormSubmissionGetParametersActivityAtLte"}},{"name":"activity_at__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityFormSubmissionGetParametersActivityAtGt"}},{"name":"activity_at__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityFormSubmissionGetParametersActivityAtLt"}},{"name":"lead_id__in","in":"query","required":false,"schema":{"type":"string"}},{"name":"user_id__in","in":"query","required":false,"schema":{"type":"string"}},{"name":"contact_id__in","in":"query","required":false,"schema":{"type":"string"}},{"name":"_type__in","in":"query","required":false,"schema":{"type":"string"}},{"name":"form_id","in":"query","description":"Filter by a specific form ID.","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"form_id__in","in":"query","description":"Filter by multiple form IDs (comma-separated).","required":false,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.form_submissions_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/form_submission/{id}/":{"get":{"operationId":"activitiesFormSubmissions_get","summary":"Get a single FormSubmission activity","tags":["activities.form_submissions"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormSubmissionActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"activitiesFormSubmissions_delete","summary":"Delete a FormSubmission activity","tags":["activities.form_submissions"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.form_submissions_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/status_change/lead/":{"get":{"operationId":"activitiesLeadStatusChanges_list","summary":"List or filter all LeadStatusChange activities","tags":["activities.lead_status_changes"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"id__in","in":"query","description":"Filter by activity IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"lead_id","in":"query","description":"Filter by lead IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"contact_id","in":"query","description":"Filter by contact IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"user_id","in":"query","description":"Filter by user IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type","in":"query","description":"Filter by activity type, e.g. Call (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"date_created__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityStatusChangeLeadGetParametersDateCreatedGte"}},{"name":"date_created__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityStatusChangeLeadGetParametersDateCreatedLte"}},{"name":"date_created__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityStatusChangeLeadGetParametersDateCreatedGt"}},{"name":"date_created__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityStatusChangeLeadGetParametersDateCreatedLt"}},{"name":"activity_at__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityStatusChangeLeadGetParametersActivityAtGte"}},{"name":"activity_at__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityStatusChangeLeadGetParametersActivityAtLte"}},{"name":"activity_at__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityStatusChangeLeadGetParametersActivityAtGt"}},{"name":"activity_at__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityStatusChangeLeadGetParametersActivityAtLt"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.lead_status_changes_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"activitiesLeadStatusChanges_create","summary":"Create a new LeadStatusChange activity","description":"Creating a lead status change does not change the lead's status. It only logs the status change event in the lead's activity feed. This should only be used to import historical status changes from another system.","tags":["activities.lead_status_changes"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadStatusChangeActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/status_change/lead/{id}/":{"get":{"operationId":"activitiesLeadStatusChanges_get","summary":"Get a single LeadStatusChange activity","tags":["activities.lead_status_changes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadStatusChangeActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"activitiesLeadStatusChanges_delete","summary":"Delete a single LeadStatusChange activity","description":"Deleting a LeadStatusChange does not change the status of the Lead. It only removes the status change event from the Lead's activity feed.\n\nIt should only be used if the status change is irrelevant (such as records for a change that has been reverted) and having it in the activity feed is causing integration problems with another system.","tags":["activities.lead_status_changes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.lead_status_changes_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/status_change/opportunity/":{"get":{"operationId":"activitiesOpportunityStatusChanges_list","summary":"List or filter all OpportunityStatusChange activities","tags":["activities.opportunity_status_changes"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"id__in","in":"query","description":"Filter by activity IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"lead_id","in":"query","description":"Filter by lead IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"contact_id","in":"query","description":"Filter by contact IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"user_id","in":"query","description":"Filter by user IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type","in":"query","description":"Filter by activity type, e.g. Call (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"date_created__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityStatusChangeOpportunityGetParametersDateCreatedGte"}},{"name":"date_created__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityStatusChangeOpportunityGetParametersDateCreatedLte"}},{"name":"date_created__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityStatusChangeOpportunityGetParametersDateCreatedGt"}},{"name":"date_created__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityStatusChangeOpportunityGetParametersDateCreatedLt"}},{"name":"activity_at__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityStatusChangeOpportunityGetParametersActivityAtGte"}},{"name":"activity_at__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityStatusChangeOpportunityGetParametersActivityAtLte"}},{"name":"activity_at__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityStatusChangeOpportunityGetParametersActivityAtGt"}},{"name":"activity_at__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityStatusChangeOpportunityGetParametersActivityAtLt"}},{"name":"opportunity_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.opportunity_status_changes_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"activitiesOpportunityStatusChanges_create","summary":"Create a new OpportunityStatusChange activity","description":"Creating an opportunity status change does not change the opportunity's status. It only logs the status change event. This should only be used to import historical status changes from another system.","tags":["activities.opportunity_status_changes"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityStatusChangeActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/status_change/opportunity/{id}/":{"get":{"operationId":"activitiesOpportunityStatusChanges_get","summary":"Get a single OpportunityStatusChange activity","tags":["activities.opportunity_status_changes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityStatusChangeActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"activitiesOpportunityStatusChanges_delete","summary":"Delete a single OpportunityStatusChange activity","description":"Deleting an OpportunityStatusChange does not change the status of the Opportunity. It only removes the status change event from the Lead's activity feed.\n\nIt should only be used if the status change is irrelevant (such as records for a change that has been reverted) and having it in the activity feed is causing integration problems with another system.","tags":["activities.opportunity_status_changes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.opportunity_status_changes_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/lead_merge/":{"get":{"operationId":"activitiesLeadMerges_list","summary":"List or filter all LeadMerge activities","tags":["activities.lead_merges"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"id__in","in":"query","description":"Filter by activity IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"lead_id","in":"query","description":"Filter by lead IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"contact_id","in":"query","description":"Filter by contact IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"user_id","in":"query","description":"Filter by user IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type","in":"query","description":"Filter by activity type, e.g. Call (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"date_created__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityLeadMergeGetParametersDateCreatedGte"}},{"name":"date_created__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityLeadMergeGetParametersDateCreatedLte"}},{"name":"date_created__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityLeadMergeGetParametersDateCreatedGt"}},{"name":"date_created__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityLeadMergeGetParametersDateCreatedLt"}},{"name":"activity_at__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityLeadMergeGetParametersActivityAtGte"}},{"name":"activity_at__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityLeadMergeGetParametersActivityAtLte"}},{"name":"activity_at__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityLeadMergeGetParametersActivityAtGt"}},{"name":"activity_at__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityLeadMergeGetParametersActivityAtLt"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.lead_merges_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/lead_merge/{id}/":{"get":{"operationId":"activitiesLeadMerges_get","summary":"Get a single LeadMerge activity","tags":["activities.lead_merges"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadMergeActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/task_completed/":{"get":{"operationId":"activitiesTaskCompletions_list","summary":"List or filter all TaskCompleted activities","tags":["activities.task_completions"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"id__in","in":"query","description":"Filter by activity IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"lead_id","in":"query","description":"Filter by lead IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"contact_id","in":"query","description":"Filter by contact IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"user_id","in":"query","description":"Filter by user IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type","in":"query","description":"Filter by activity type, e.g. Call (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"date_created__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityTaskCompletedGetParametersDateCreatedGte"}},{"name":"date_created__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityTaskCompletedGetParametersDateCreatedLte"}},{"name":"date_created__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityTaskCompletedGetParametersDateCreatedGt"}},{"name":"date_created__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityTaskCompletedGetParametersDateCreatedLt"}},{"name":"activity_at__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityTaskCompletedGetParametersActivityAtGte"}},{"name":"activity_at__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityTaskCompletedGetParametersActivityAtLte"}},{"name":"activity_at__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityTaskCompletedGetParametersActivityAtGt"}},{"name":"activity_at__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityTaskCompletedGetParametersActivityAtLt"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.task_completions_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/task_completed/{id}/":{"get":{"operationId":"activitiesTaskCompletions_get","summary":"Get a single TaskCompleted activity","tags":["activities.task_completions"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskCompletedActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"activitiesTaskCompletions_delete","summary":"Delete a TaskCompleted activity","tags":["activities.task_completions"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.task_completions_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/import_update/":{"get":{"operationId":"activitiesImportUpdates_list","summary":"List or filter all ImportUpdate activities","description":"Get a list of ImportUpdate activities, which record bulk import operations that modified existing leads. Each ImportUpdate is associated with a bulk import (`import_id`) and indicates whether the change has been reverted.","tags":["activities.import_updates"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"id__in","in":"query","description":"Filter by activity IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"lead_id","in":"query","description":"Filter by lead IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"contact_id","in":"query","description":"Filter by contact IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"user_id","in":"query","description":"Filter by user IDs (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_type","in":"query","description":"Filter by activity type, e.g. Call (comma-separated)","required":false,"schema":{"type":["array","null"],"items":{"type":"string"},"default":null}},{"name":"date_created__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityImportUpdateGetParametersDateCreatedGte"}},{"name":"date_created__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityImportUpdateGetParametersDateCreatedLte"}},{"name":"date_created__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityImportUpdateGetParametersDateCreatedGt"}},{"name":"date_created__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityImportUpdateGetParametersDateCreatedLt"}},{"name":"activity_at__gte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityImportUpdateGetParametersActivityAtGte"}},{"name":"activity_at__lte","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityImportUpdateGetParametersActivityAtLte"}},{"name":"activity_at__gt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityImportUpdateGetParametersActivityAtGt"}},{"name":"activity_at__lt","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ActivityImportUpdateGetParametersActivityAtLt"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.import_updates_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/activity/import_update/{id}/":{"get":{"operationId":"activitiesImportUpdates_get","summary":"Get a single ImportUpdate activity","tags":["activities.import_updates"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportUpdateActivity"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"activitiesImportUpdates_delete","summary":"Delete an ImportUpdate activity","tags":["activities.import_updates"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activities.import_updates_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/webhook/":{"get":{"operationId":"webhooks_list","summary":"List Webhook subscriptions","description":"List all webhook subscriptions for the organization.","tags":["webhooks"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"webhooks_create","summary":"Create new Webhook subscription","description":"The subscription will send events to the specified URL.","tags":["webhooks"],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks_create_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhook"}}}},"security":[{"ApiKeyAuth":[]}]}},"/webhook/{id}/":{"get":{"operationId":"webhooks_get","summary":"Retrieve a single Webhook subscription","description":"The response contains the subscription details.","tags":["webhooks"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"webhooks_update","summary":"Update existing Webhook subscription","tags":["webhooks"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks_update_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWebhook"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"webhooks_delete","summary":"Delete Webhook subscription","tags":["webhooks"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/event/":{"get":{"operationId":"events_list","summary":"Retrieve a list of events","description":"The list of available object types and actions is available [here](https://developer.close.com/api/resources/events/list-of-event-types). The event log can be filtered by the following parameters:\n\n- `date_updated`: The date/time of when the event was last updated, in ISO format. Can be filtered by range (`date_updated__gte=X&date_updated__lte=Y`). Note: For pagination, it is recommended to use cursors instead of this filter (see below).\n- `object_type`: If specified, only events for objects of a given type are returned. Example: `object_type=lead`\n- `object_id`: If specified, only events for the given object are returned. No related object events are returned. Example: `object_id=lead_123`\n- `action`: Only events of specified actions are returned. Example: `action=deleted`\n- `lead_id`: If specified, events for the given lead, including any of its related objects (contacts, activities, opportunities, tasks) are returned.\n- `user_id`: Only return events of the given user.\n- `request_id`: Only events emitted while processing this specific API request.\n\nOnly certain combinations of filters are supported. `date_updated` can be optionally used with any allowed filter combination. Supported combinations are:\n\n- `object_type` and `object_id`\n- `object_type` and `action`\n- `object_id` and `action`\n- `lead_id` and `object_type`\n- `lead_id`, `object_type` and `action`\n- `lead_id`, `user_id` and `object_type`\n- `lead_id`, `user_id`, `object_type` and `action`\n- `lead_id` and `user_id`\n- `user_id` and `object_id`\n- `user_id`, `object_id` and `action`\n- `user_id` and `object_type`\n- `user_id`, `object_type` and `action`\n- Just `lead_id`\n- Just `user_id`\n- Just `request_id`\n\nThe response is a dictionary with the following fields:\n\n- `data`: A list of events (dictionaries), using the format outlined in “Event format”.\n- `cursor_next`: Cursor string to retrieve the next page of events, i.e. events before the given ID (earlier date), or `null` if no more objects are available.\n- `cursor_previous`: Cursor string to retrieve the previous page of events, i.e. events after the given ID (later date), or `null` if no more objects are available.\n\nEvents are always ordered by date (latest first), i.e. the `date_updated` field. Note that even though `date_created` and `date_updated` may only have millisecond-precision, two or more events for the same object are guaranteed to be returned in the proper order.\n\nThe endpoint supports the following parameters for pagination, and does *not* support `_skip`:\n\n- `_cursor`: Pagination using a cursor string (`cursor_next` or `cursor_previous` from a previous response). Note that you still need to supply any other filters (except for `date_updated`) that were used in the previous query.\n- `_limit`: Maximum number of events to return (capped at and defaulting to 50).\n\nCursors are a reliable way to go to the next or previous page of events (unlike filtering by `date_updated`, where you may need to account for and filter out multiple events happening in the same millisecond). However, cursors are not designed to stream new events: Events may be visible through the API in a different order than they were triggered (but the ordering returned by the API is correct). Also, event consolidation of multiple recent events to the same object may occur. To avoid missing recent events when paginating, we recommend to scan the latest five minutes of events.\n\nIn the example response, to retrieve the next older batch of events, specify `_cursor=cursor2`.","tags":["events"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"object_type","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"object_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"lead_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"action","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"user_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_updated__gt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_updated__gte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_updated__lt","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"date_updated__lte","in":"query","required":false,"schema":{"type":["string","null"],"default":null}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/events_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/event/{id}/":{"get":{"operationId":"events_get","summary":"Retrieve a single event by ID","description":"The response contains a dictionary with a single event, using the format outlined in “Event format”.","tags":["events"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/events_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/saved_search/":{"get":{"operationId":"smartViews_list","summary":"List Smart Views","description":"Accepts:\n\n- A `type` filter that accepts either `lead` or `contact`. Defaults to `lead`.\n- A `type__in` filter that can be used to select multiple comma-separated types: `lead,contact`.","tags":["smart_views"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"type","in":"query","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/SavedSearchType"},{"type":"null"}],"default":null}},{"name":"type__in","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/SavedSearchType"}}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smart_views_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"smartViews_create","summary":"Create a Smart View","description":"Create a Lead or Contact Smart View.\n\nFor Lead Smart Views, the `type` field is optional (since `lead` is the default `type`).\n\nWhen 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](https://developer.close.com/api/resources/advanced-filtering) section. See the examples below.","tags":["smart_views"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearch"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/saved_search/{id}/":{"get":{"operationId":"smartViews_get","summary":"Get a single Smart View","tags":["smart_views"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearch"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"smartViews_update","summary":"Update a Smart View","tags":["smart_views"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearch"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"smartViews_delete","summary":"Delete a Smart View","tags":["smart_views"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smart_views_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/report/activity/":{"post":{"operationId":"reporting_getActivity","summary":"Get an activity report","description":"The activity report returns the organization's metrics per time period (**overview** report) or user (**comparison** report).\n\nEvery report accepts the following parameters:\n\n* `datetime_range`: a time range to fetch data for. Either this field or `relative_range` needs to be specified.\n* `relative_range`: a relative time range to fetch data for. The allowed values are: `today`, `this-week`, `this-month`, `this-quarter`, `this-year`, `yesterday`, `last-week`, `last-month`, `last-quarter`, `last-year`, and `all-time`. Either this field or `datetime_range` needs to be specified.\n* `query`: a query to apply to the report to filter out data.\n  The value of the field is a dictionary with the key `type` and any type-specific keys. For now only the type `saved_search` is allowed which takes the extra key `saved_search_id` to specify the ID of a saved search. This parameter is *optional*.\n* `users`: a list of user IDs to limit the report results to. This parameter is *optional*.\n* `type`: the type of the report. The available values are `overview` and `comparison`.\n  This parameter is *mandatory*.\n* `metrics`: a list of metrics (see [List Activity Metrics](/api/resources/reporting/list-activity-metrics)) to fetch for the report. This parameter is *mandatory*.\n\nThe report can be requested either in a JSON format or in a CSV file. The format can be specified with the `accept` header.","tags":["reporting"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting_getActivity_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/report/activity/metrics/":{"get":{"operationId":"reporting_listActivityMetrics","summary":"List the predefined metrics used in activity reports","description":"List available metrics that can be used in activity reports.","tags":["reporting"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting_listActivityMetrics_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/report/custom/{org_id}/":{"get":{"operationId":"reporting_getCustom","summary":"Get custom report (Explorer)","description":"This endpoint returns data that allows graphing of arbitrary metrics and is what powers \"Explorer\" in the UI.\n\n - `query` is an optional search query filter. When reporting on leads, any regular lead search query may be used. When reporting on activities or opportunities, only properties of the chosen object type may be used. For example, `direction:incoming` may be used if `x` starts with `email.`. Defaults to `*`, which includes all objects.\n - `y` is made up of the object type and field which is reported on the Y axis. For example the value `lead.count` (used by default) may be used to graph the number of leads, or a numeric field may be used. Examples: `call.duration` (for call length), `opportunity.value` (for value of opportunities).\n - `x` is the field which is reported on the X axis, for example \"lead.custom.MRR\" or \"opportunity.date_created\".\n - `interval`: Graph interval, i.e. the precision of the X axis. For time based graphs (`x` is a date field), one of `auto`, `hour`, `day`, `week`, `month`, `quarter`, `year` (defaults to `auto`, which is chosen based on `start` and `end`). For graphs with a numeric X axis, an integer number can be specified to indicate the histogram interval (`auto` by default).\n - `group_by`: Optional field name by which the report will be grouped. When grouping, a separate series will be returned for each group. By default no grouping is applied.\n - `transform_y`: Transformation function that gets applied to the `y` parameter. One of `sum` (default), `avg`, `min`, or `max`. Does not apply for `.count` `y` values if `x` is of the same object type.\n - `start`: Date or integer of the start of the X axis range. For dates, defaults to the date of creation of your organization.\n - `end`: Date or integer of the end of the X axis range. For dates, defaults to now.\n\n To get a full list of fields that can be used, do a GET to `/report/custom/fields/`. Only the `number` data type can be used for the `y` parameter.","tags":["reporting"],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"query","in":"query","required":false,"schema":{"type":"string"}},{"name":"x","in":"query","required":false,"schema":{"type":"string"}},{"name":"y","in":"query","required":false,"schema":{"type":"string"}},{"name":"group_by","in":"query","required":false,"schema":{"type":"string"}},{"name":"transform_y","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ReportCustomOrgIdGetParametersTransformY"}},{"name":"interval","in":"query","required":false,"schema":{"type":"string"}},{"name":"start","in":"query","required":false,"schema":{"type":"string"}},{"name":"end","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting_getCustom_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/report/funnel/opportunity/stages/":{"post":{"operationId":"reporting_getFunnelStages","summary":"Get a funnel report (stages)","description":"The opportunity funnel \"stages\" report returns the pipeline funnel's metrics for the selected opportunities, aggregated (JSON format only) and per-user (JSON and CSV formats).\n\nEvery report accepts the following parameters:\n\n* `pipeline`: ID of the pipeline defining the funnel statuses.\n* `type`: the type of the report. The available values are `created-cohort` and `active-stage-cohort`.\n* `report_relative_range`: a relative time range to fetch data for. The allowed values are: `today`, `this-week`, `this-month`, `this-quarter`, `this-year`, `yesterday`, `last-week`, `last-month`, `last-quarter`, `last-year`, and `all-time`.\n* `report_datetime_range`: a time range to fetch data for.\n* `cohort_relative_range`: a relative time range defining the cohort of created opportunities to fetch data for, by date of creation of those opportunities. The allowed values are: `today`, `this-week`, `this-month`, `this-quarter`, `this-year`, `yesterday`, `last-week`, `last-month`, `last-quarter`, `last-year`, and `all-time`. Either this field or `cohort_datetime_range` needs to be specified for `created-cohort` reports. Its value will be ignored for `active-stage-cohort` reports.\n* `cohort_datetime_range`: a time range defining the cohort of created opportunities to fetch data for, by date of creation of those opportunities. Either this field or `cohort_relative_range` needs to be specified for `created-cohort` reports. Its value will be ignored for `active-stage-cohort` reports.\n* `compared_relative_range`: a relative time range to fetch comparison data for. Only allowed in combination with `report_relative_range` (for `active-stage-cohort` reports) or `cohort_relative_range` (for `created-cohort` reports). The allowed values are: `today`, `this-week`, `this-month`, `this-quarter`, `this-year`, `yesterday`, `last-week`, `last-month`, `last-quarter`, `last-year`, and `all-time`.\n* `compared_datetime_range`: a relative time range to fetch comparison data for. Only allowed in combination with `report_datetime_range` (for `active-stage-cohort` reports) or `cohort_datetime_range` (for `created-cohort` reports). The allowed values are: `same-days-last-week`, `same-days-last-month`, `same-days-last-quarter`, `same-days-last-year`.\n* `compared_custom_range`: a time range to fetch comparison data for.\n* `query`: a query to apply to the report to filter out data.\n  The value of the field is a dictionary with the key `type` and any type-specific keys. For now only the type `saved_search` is allowed which takes the extra key `saved_search_id` to specify the ID of a saved search. This parameter is *optional*.\n* `users`: a list of user IDs or group IDs to limit the report results to. When it's empty, the report will include all the available users. This parameter is *optional*.\n\nThe report can be requested either in JSON format or in CSV format. The format can be specified with the `accept` header.\n\nIn JSON format, it includes aggregated and per-user data. When requested in CSV format, it includes only per-user data.\n\nWhen `compared_datetime_range`, `compared_relative_range`, or `compared_custom_range` are used, the report returned is the compared one, not the base one.","tags":["reporting"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting_getFunnelStages_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/report/funnel/opportunity/totals/":{"post":{"operationId":"reporting_getFunnelTotals","summary":"Get a funnel report (totals)","description":"The opportunity funnel \"totals\" report returns the pipeline funnel's metrics for the selected opportunities, aggregated (JSON format only) and per-user (JSON and CSV formats).\n\nEvery report accepts the following parameters:\n\n* `pipeline`: ID of the pipeline defining the funnel statuses.\n* `type`: the type of the report. The available values are `created-cohort` and `active-stage-cohort`.\n* `report_relative_range`: a relative time range to fetch data for. The allowed values are: `today`, `this-week`, `this-month`, `this-quarter`, `this-year`, `yesterday`, `last-week`, `last-month`, `last-quarter`, `last-year`, and `all-time`.\n* `report_datetime_range`: a time range to fetch data for.\n* `cohort_relative_range`: a relative time range defining the cohort of created opportunities to fetch data for, by date of creation of those opportunities. The allowed values are: `today`, `this-week`, `this-month`, `this-quarter`, `this-year`, `yesterday`, `last-week`, `last-month`, `last-quarter`, `last-year`, and `all-time`. Either this field or `cohort_datetime_range` needs to be specified for `created-cohort` reports. Its value will be ignored for `active-stage-cohort` reports.\n* `cohort_datetime_range`: a time range defining the cohort of created opportunities to fetch data for, by date of creation of those opportunities. Either this field or `cohort_relative_range` needs to be specified for `created-cohort` reports. Its value will be ignored for `active-stage-cohort` reports.\n* `compared_relative_range`: a relative time range to fetch comparison data for. Only allowed in combination with `report_relative_range` (for `active-stage-cohort` reports) or `cohort_relative_range` (for `created-cohort` reports). The allowed values are: `today`, `this-week`, `this-month`, `this-quarter`, `this-year`, `yesterday`, `last-week`, `last-month`, `last-quarter`, `last-year`, and `all-time`.\n* `compared_datetime_range`: a relative time range to fetch comparison data for. Only allowed in combination with `report_datetime_range` (for `active-stage-cohort` reports) or `cohort_datetime_range` (for `created-cohort` reports). The allowed values are: `same-days-last-week`, `same-days-last-month`, `same-days-last-quarter`, `same-days-last-year`.\n* `compared_custom_range`: a time range to fetch comparison data for.\n* `query`: a query to apply to the report to filter out data.\n  The value of the field is a dictionary with the key `type` and any type-specific keys. For now only the type `saved_search` is allowed which takes the extra key `saved_search_id` to specify the ID of a saved search. This parameter is *optional*.\n* `users`: a list of user IDs or group IDs to limit the report results to. When it's empty, the report will include all the available users. This parameter is *optional*.\n\nThe report can be requested either in JSON format or in CSV format. The format can be specified with the `accept` header.\n\nIn JSON format, it includes aggregated and per-user data. When requested in CSV format, it includes only per-user data.\n\nWhen `compared_datetime_range`, `compared_relative_range`, or `compared_custom_range` are used, the report returned is the compared one, not the base one.","tags":["reporting"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting_getFunnelTotals_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/report/sent_emails/{org_id}/":{"get":{"operationId":"reporting_getSentEmails","summary":"Get sent emails report","tags":["reporting"],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"date_start","in":"query","required":false,"schema":{"type":"string"}},{"name":"date_end","in":"query","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting_getSentEmails_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/report/statuses/lead/{org_id}/":{"get":{"operationId":"reporting_getLeadStatuses","summary":"Get lead status change report","description":"Get a lead status change report.\n\nThe date range is optional. A report may be requested\nfor a specific time period or overall. You can specify\neither a `query` or `smart_view_id` (but not both) to\nfilter leads included in the report.\n\nThe following fields are returned (when requesting an\noverall report, some inapplicable fields will not be\nreturned):\n\n* `status_overview`: A list of all statuses with:\n    * `status_id`, `status_label`,\n      `status_is_deleted`: The ID and label of the\n      status, and whether it was deleted.\n    * `started`: Number of leads in this status at\n      the start of the period.\n    * `ended`: Number in this status at the end.\n    * `change`: Net change during the period\n      (`ended` minus `started`).\n    * `change_percent`: Net change in percent.\n    * `gained`: Number that were not in this status\n      at the beginning but were at the end.\n    * `lost`: Number that were in this status at the\n      beginning but were not at the end.\n    * `entered`: Number that entered this status at\n      some point during the period.\n    * `left`: Number that left this status at some\n      point during the period.\n    * `_queries`: A dictionary containing search\n      queries for the different states (`started`,\n      `ended`, `gained`, `lost`, `entered`, `left`).\n    * `_leads_page_urls`: A dictionary containing\n      paths to the lead search UI page.\n* `status_transitions`: A list of all status\n  transitions (aggregated by start/end status) for\n  the given period with:\n    * `from_status_id`, `from_status_label`,\n      `from_status_is_deleted`: Starting status\n      (null for created leads).\n    * `to_status_id`, `to_status_label`,\n      `to_status_is_deleted`: Ending status.\n    * `count`: The number that transitioned.\n    * `_query`: The search query for those records.\n    * `_leads_page_url`: Path to the search UI page.\n* `status_transitions_summary`: Status transitions\n  summarized for the period. E.g. a lead that went\n  A→B→C is counted as A→C.","tags":["reporting"],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"date_start","in":"query","required":false,"schema":{"type":"string"}},{"name":"date_end","in":"query","required":false,"schema":{"type":"string"}},{"name":"query","in":"query","required":false,"schema":{"type":"string"}},{"name":"smart_view_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting_getLeadStatuses_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/report/statuses/opportunity/{org_id}/":{"get":{"operationId":"reporting_getOpportunityStatuses","summary":"Get opportunity status change report","description":"Get an opportunity status change report.\n\nThe date range is optional. A report may be requested\nfor a specific time period or overall. You can specify\neither a `query` or `smart_view_id` (but not both) to\nfilter opportunities included in the report. The\nreport may optionally be filtered by the opportunity\nuser.\n\nThe following fields are returned (when requesting an\noverall report, some inapplicable fields will not be\nreturned):\n\n* `status_overview`: A list of all statuses with:\n    * `status_id`, `status_label`,\n      `status_is_deleted`: The ID and label of the\n      status, and whether it was deleted.\n    * `started`: Number of opportunities in this\n      status at the start of the period.\n    * `ended`: Number in this status at the end.\n    * `change`: Net change during the period\n      (`ended` minus `started`).\n    * `change_percent`: Net change in percent.\n    * `gained`: Number that were not in this status\n      at the beginning but were at the end.\n    * `lost`: Number that were in this status at the\n      beginning but were not at the end.\n    * `entered`: Number that entered this status at\n      some point during the period.\n    * `left`: Number that left this status at some\n      point during the period.\n    * `_queries`: A dictionary containing search\n      queries for the different states (`started`,\n      `ended`, `gained`, `lost`, `entered`, `left`).\n      Search queries are wrapped in a nested\n      `opportunity(...)` clause. To pass the query\n      to the opportunities API endpoint, use only\n      the query within the parentheses.\n    * `_leads_page_urls`: A dictionary containing\n      paths to the lead search UI page.\n    * `_opportunities_page_urls`: A dictionary\n      containing paths to the opportunity UI page.\n* `status_transitions`: A list of all status\n  transitions (aggregated by start/end status) for\n  the given period with:\n    * `from_status_id`, `from_status_label`,\n      `from_status_is_deleted`: Starting status\n      (null for created opportunities).\n    * `to_status_id`, `to_status_label`,\n      `to_status_is_deleted`: Ending status.\n    * `count`: The number that transitioned.\n    * `_query`: The search query for those records.\n    * `_leads_page_url`: Path to the search UI page.\n    * `_opportunities_page_url`: Path to the\n      opportunity UI page.\n* `status_transitions_summary`: Status transitions\n  summarized for the period. E.g. an opportunity\n  that went A→B→C is counted as A→C.","tags":["reporting"],"parameters":[{"name":"org_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"date_start","in":"query","required":false,"schema":{"type":"string"}},{"name":"date_end","in":"query","required":false,"schema":{"type":"string"}},{"name":"query","in":"query","required":false,"schema":{"type":"string"}},{"name":"smart_view_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"user_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting_getOpportunityStatuses_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/sequence/":{"get":{"operationId":"sequences_list","summary":"List Sequences","tags":["sequences"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sequences_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"sequences_create","summary":"Create a Sequence","tags":["sequences"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sequences_create_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/sequence/{id}/":{"get":{"operationId":"sequences_get","summary":"Fetch a Sequence","tags":["sequences"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sequences_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"sequences_update","summary":"Update a Sequence","description":"**Note**: If you include `steps` in the payload and exclude some of the existing steps in your sequence, it will remove those steps from the sequence entirely.","tags":["sequences"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sequences_update_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"sequences_delete","summary":"Delete a Sequence","tags":["sequences"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sequences_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/sequence_subscription/":{"get":{"operationId":"sequences_listSubscriptions","summary":"List Sequence Subscriptions","description":"At least one of `sequence_id`, `contact_id`, and `lead_id` is required.","tags":["sequences"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"contact_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"lead_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"sequence_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sequences_listSubscriptions_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"sequences_createSubscription","summary":"Subscribe a Contact to a Sequence","tags":["sequences"],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sequences_createSubscription_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/sequence_subscription/{id}/":{"get":{"operationId":"sequences_getSubscription","summary":"Fetch a single Sequence Subscription","tags":["sequences"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sequences_getSubscription_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"sequences_updateSubscription","summary":"Update a specific Subscription","description":"Setting `status` to `active` restarts the Subscription, so it requires a plan that includes Workflow runs and otherwise returns a 400. Setting it to `paused` works on every plan.","tags":["sequences"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sequences_updateSubscription_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"sequences_deleteSubscription","summary":"Delete a Sequence Subscription","description":"Unsubscribe a contact from a sequence by deleting their subscription.","tags":["sequences"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sequences_deleteSubscription_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/bulk_action/email/":{"get":{"operationId":"bulkActionsEmail_list","summary":"List bulk emails","tags":["bulk_actions.email"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}},{"name":"template_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulk_actions.email_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"bulkActionsEmail_create","summary":"Initiate a new bulk email","description":"`contact_preference` can be set to `lead` (only email the primary/first contact email of the lead) or `contact` (email the first contact email of each contact of the lead).","tags":["bulk_actions.email"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkEmailAction"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/bulk_action/email/{id}/":{"get":{"operationId":"bulkActionsEmail_get","summary":"Fetch a single bulk email object","tags":["bulk_actions.email"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkEmailAction"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/bulk_action/edit/":{"get":{"operationId":"bulkActionsEdit_list","summary":"List bulk edits","tags":["bulk_actions.edit"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulk_actions.edit_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"bulkActionsEdit_create","summary":"Initiate a new bulk edit","description":"Pass additional parameters depending on which `type` is passed:\n\n - `set_lead_status` will set the Lead Status on all leads. It expects:\n  - `lead_status_id` - ID of the Lead Status to use.\n - `clear_custom_field` will clear/remove/unset a specific custom field from all leads. It expects:\n  - `custom_field_id` or `custom_field_name` - ID or exact name of the custom field to remove.\n - `set_custom_field` will set/update/add a specific custom field on all leads. It expects:\n  - `custom_field_id` or `custom_field_name` - ID or exact name of the custom field to set/update.\n  - `custom_field_value` - New value. Use `custom_field_values` to pass multiple values to custom fields that support it.\n  - `custom_field_operation` - `replace`, `add`, or `remove` (defaults to `replace`). Only applicable for custom fields that accept multiple values.\n\nUse `\"send_done_email\": false` if you don't want to get a confirmation email after the bulk action is done.","tags":["bulk_actions.edit"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkEditAction"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/bulk_action/edit/{id}/":{"get":{"operationId":"bulkActionsEdit_get","summary":"Fetch a single bulk edit object","tags":["bulk_actions.edit"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkEditAction"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/bulk_action/delete/":{"get":{"operationId":"bulkActionsDelete_list","summary":"List bulk deletes","tags":["bulk_actions.delete"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulk_actions.delete_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"bulkActionsDelete_create","summary":"Initiate a new bulk delete","description":"Use `\"send_done_email\": false` if you don't want to get a confirmation email after the bulk action is done.","tags":["bulk_actions.delete"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDeleteAction"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/bulk_action/delete/{id}/":{"get":{"operationId":"bulkActionsDelete_get","summary":"Fetch a single bulk delete object","tags":["bulk_actions.delete"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDeleteAction"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/bulk_action/sequence_subscription/":{"get":{"operationId":"bulkActionsSequenceSubscriptions_list","summary":"List bulk sequence subscriptions","tags":["bulk_actions.sequence_subscriptions"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulk_actions.sequence_subscriptions_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"bulkActionsSequenceSubscriptions_create","summary":"Initiate a new bulk sequence subscription","description":"`action_type` must be one of:\n\n- `subscribe` to create a new sequence subscription for contacts that have never received the given sequence.\n- `resume` to resume any paused sequence subscriptions for the given sequence or all sequences if `sequence_id` is not provided.\n- `resume_finished` to resume any finished sequence subscriptions for the given sequence or all sequences if `sequence_id` is not provided.\n- `pause` to pause any active sequence subscriptions for the given sequence or all sequences if `sequence_id` is not provided.\n\n`sequence_id`, `sender_account_id`, `sender_name`, `sender_email` and `contact_preference` are required if `action_type` is `subscribe`.\n\n`contact_preference` can be set to:\n\n- `lead` to only subscribe the primary/first contact email of the lead.\n- `contact` to subscribe the primary email of each contact of the lead.\n\n`subscribe`, `resume` and `resume_finished` all start or restart Workflow\nruns, so they require a plan that includes them and otherwise return a 400.\n`pause` and `reassign` remain available on every plan.","tags":["bulk_actions.sequence_subscriptions"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkSequenceSubscriptionAction"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/bulk_action/sequence_subscription/{id}/":{"get":{"operationId":"bulkActionsSequenceSubscriptions_get","summary":"Fetch a single bulk sequence subscription object","tags":["bulk_actions.sequence_subscriptions"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkSequenceSubscriptionAction"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/export/":{"get":{"operationId":"exports_list","summary":"List all the exports","tags":["exports"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/exports_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/export/lead/":{"get":{"operationId":"exports_listLead","summary":"List Lead Exports","tags":["exports"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/exports_listLead_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"exports_createLead","summary":"Export leads based on a search query","description":"You will receive a link to the generated file via email once the export is done.\n\nThe exported file is GZIP compressed to make your download and our upload faster. The `content-encoding` HTTP header will be set to `gzip` and the `content-type` HTTP header will be set to `text/csv` for CSV exports or `application/json` for JSON exports.\n\nParameters:\n  - `s_query/results_limit/sort` (optional) - The [Advanced Filtering API](https://developer.close.com/api/resources/advanced-filtering) parameters used to narrow the exported results down. By default, all leads are exported.\n  - `format` - Format of the exported file. The choices are: `csv`, `json`. JSON is recommended for raw backups or data migrations.\n  - `type` - Type of the export.\n    - `leads` - For CSV exports, it results in one row per lead. For JSON exports, this is the recommended type and is a superset of the other two types.\n    - `contacts` - For CSV exports, it results in one row per contact.\n    - `lead_opps` - For CSV exports, it results in one row per opportunity.\n  - `date_format` (optional) - Controls the format of date objects. Note: this only works with the `csv` format.\n    - `original` (default) - A date format that includes microseconds and timezone information.\n        - Date: `[YYYY]-[MM]-[DD]`\n        - Date w/ time: `[YYYY]-[MM]-[DD] [hh]:[mm]:[ss.sssss]±[hh]:[mm]`\n    - `iso8601` (recommended) - An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compatible date representation that does not include microseconds.\n        - Date: `[YYYY]-[MM]-[DD]`\n        - Date w/ time: `[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]±[hh]:[mm]`\n    - `excel` - An Excel compatible date format. Dates are always in UTC, do not include timezone information or microseconds, and use a 12 hour clock with an AM or PM designation.\n        - Date: `[YYYY]-[MM]-[DD]`\n        - Date w/ time: `[YYYY]-[MM]-[DD] [hh]:[mm]:[ss] [AM|PM]`\n  - `fields` (optional) - By default we return all the data fields in each export type. If you only need specific fields exported, you can explicitly list them in `fields` to get smaller exports.\n  - `include_activities` (optional) - Activities aren't included in any exports by default. If you want all your Activities exported as well, pass `\"include_activities\": true`. Note: this only works for `leads` type with `json` format.\n  - `include_smart_fields` (optional) - Smart Fields aren't included in any exports by default. If you want all of them exported as well, pass `\"include_smart_fields\": true`. Note: this only works for `leads` type with `json` format or any type formatted as `csv`. Smart fields are calculated fields, like number of emails on a lead.\n  - `send_done_email` - Set to `false` if you don't want to get a confirmation email after the bulk action is done.","tags":["exports"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Export"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/export/lead/{id}/":{"get":{"operationId":"exports_getLead","summary":"Get a single Lead Export","description":"Get a single lead export to do things like check its `status` or get a `download_url`.\n\n`status` can have one of these values: `created`, `started`, `in_progress`, `done`, `error`.","tags":["exports"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Export"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/export/opportunity/":{"get":{"operationId":"exports_listOpportunity","summary":"List Opportunity Exports","tags":["exports"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/exports_listOpportunity_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"exports_createOpportunity","summary":"Export opportunities, based on opportunity filters","description":"Parameters:\n  - `params` (optional) - A dictionary of filters, which would be used for the `/opportunity/` endpoint.\n  - `format` - Format of the exported file. The choices are: `csv`, `json`\n  - `date_format` (optional) - Controls the format of date objects. Note: this only works with the `csv` format.\n    - `original` (default) - A date format that includes microseconds and timezone information.\n        - Date: `[YYYY]-[MM]-[DD]`\n        - Date w/ time: `[YYYY]-[MM]-[DD] [hh]:[mm]:[ss.sssss]±[hh]:[mm]`\n    - `iso8601` (recommended) - An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compatible date representation that does not include microseconds.\n        - Date: `[YYYY]-[MM]-[DD]`\n        - Date w/ time: `[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]±[hh]:[mm]`\n    - `excel` - An Excel compatible date format. Dates are always in UTC, do not include timezone information or microseconds, and use a 12 hour clock with an AM or PM designation.\n        - Date: `[YYYY]-[MM]-[DD]`\n        - Date w/ time: `[YYYY]-[MM]-[DD] [hh]:[mm]:[ss] [AM|PM]`\n  - `fields` (optional) - By default we return all the data fields. If you only need specific fields exported, you can explicitly list them in fields to get smaller exports.\n  - `send_done_email` - Set to `false` if you don't want to get a confirmation email after the bulk action is done.","tags":["exports"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Export"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/export/opportunity/{id}/":{"get":{"operationId":"exports_getOpportunity","summary":"Get a single Opportunity Export","description":"Get a single opportunity export to do things like check its `status` or get a `download_url`.\n\n`status` can have one of these values: `created`, `started`, `in_progress`, `done`, `error`.","tags":["exports"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Export"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/export/{id}/":{"get":{"operationId":"exports_get","summary":"Get a single Export","description":"You can get a single export to do things like check its `status` or get a `download_url`\n\n - `status` can have one of these values: `created`, `started`, `in_progress`, `done`, `error`.","tags":["exports"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Export"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/enrich_field/":{"post":{"operationId":"fieldEnrichment_create","summary":"Enrich a specific field on a lead or contact using AI","description":"This endpoint uses AI to enrich (populate or enhance) a specific field on a lead or contact. The enrichment process analyzes existing data and external sources to provide intelligent field values.\n\n**Parameters:**\n- `organization_id` (required): The organization ID\n- `object_type` (required): Either \"lead\" or \"contact\"\n- `object_id` (required): The ID of the lead or contact to enrich\n- `field_id` (required): The ID of the custom field to enrich\n- `set_new_value` (optional): Whether to update the field with the enriched value (default: true)\n- `overwrite_existing_value` (optional): Whether to overwrite existing field values (default: false)","tags":["field_enrichment"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/field_enrichment_create_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunFieldEnrichment"}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_field_schema/{object_type}/":{"get":{"operationId":"customFieldSchemas_get","summary":"Retrieve a custom field schema","tags":["custom_field_schemas"],"parameters":[{"name":"object_type","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_field_schemas_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"customFieldSchemas_update","summary":"Update a custom field schema","description":"To reorder Custom Fields (and thus change the order in which they are displayed in the Close UI), you simply need to supply a `fields` list with `{\"id\": ...}` items corresponding to the IDs of the Custom Fields belonging to the given Schema. Note that any IDs that are omitted from the list with be automatically appended to the end of the list. If you want to remove some Fields from the Schema, then delete the Custom Field or – in case of Shared Custom Fields – disassociate the Field from the given object.","tags":["custom_field_schemas"],"parameters":[{"name":"object_type","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_field_schemas_update_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_field/lead/":{"get":{"operationId":"customFieldsLead_list","summary":"List Lead Custom Fields","description":"List all the lead custom fields for your organization.","tags":["custom_fields.lead"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.lead_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"customFieldsLead_create","summary":"Create a new Lead Custom Field","tags":["custom_fields.lead"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.lead_create_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_field/lead/{id}/":{"get":{"operationId":"customFieldsLead_get","summary":"Fetch Lead Custom Field's details","tags":["custom_fields.lead"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.lead_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"customFieldsLead_update","summary":"Update a Lead Custom Field","description":"You can rename it, change its type, change whether it accepts multiple values or not, change whether editing its values is restricted to specific Roles, or update the options for a \"choices\" field type. The updated name will immediately appear in the Close UI and only valid values for the updated `type` will be returned by the Lead API.\n\nSome of the type changes need to convert all of the existing values for a given Custom Field to the new type. When this is required, the response will include an additional `converting_to_type` field. When the conversion is done, `converting_to_type` will no longer be returned.","tags":["custom_fields.lead"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.lead_update_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"customFieldsLead_delete","summary":"Delete a Lead Custom Field","description":"Delete a lead custom field. The field will immediately disappear from API responses and values on existing leads will be permanently removed.","tags":["custom_fields.lead"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.lead_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_field/contact/":{"get":{"operationId":"customFieldsContact_list","summary":"List Contact Custom Fields","description":"List all the contact custom fields for your organization.","tags":["custom_fields.contact"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.contact_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"customFieldsContact_create","summary":"Create a new Contact Custom Field","tags":["custom_fields.contact"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.contact_create_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_field/contact/{id}/":{"get":{"operationId":"customFieldsContact_get","summary":"Fetch Contact Custom Field's details","tags":["custom_fields.contact"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.contact_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"customFieldsContact_update","summary":"Update a Contact Custom Field","description":"You can rename it, change its type, change whether it accepts multiple values or not, change whether editing its values is restricted to specific Roles, or update the options for a \"choices\" field type. The updated name will immediately appear in the Close UI and only valid values for the updated `type` will be returned by the Contact API.\n\nSome of the type changes need to convert all of the existing values for a given Custom Field to the new type. When this is required, the response will include an additional `converting_to_type` field. When the conversion is done, `converting_to_type` will no longer be returned.","tags":["custom_fields.contact"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.contact_update_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"customFieldsContact_delete","summary":"Delete a Contact Custom Field","description":"Delete a contact custom field. The field will immediately disappear from API responses and values on existing contacts will be permanently removed.","tags":["custom_fields.contact"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.contact_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_field/opportunity/":{"get":{"operationId":"customFieldsOpportunity_list","summary":"List Opportunity Custom Fields","description":"List all the opportunity custom fields for your organization.","tags":["custom_fields.opportunity"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.opportunity_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"customFieldsOpportunity_create","summary":"Create a new Opportunity Custom Field","tags":["custom_fields.opportunity"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.opportunity_create_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_field/opportunity/{id}/":{"get":{"operationId":"customFieldsOpportunity_get","summary":"Fetch Opportunity Custom Field's details","tags":["custom_fields.opportunity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.opportunity_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"customFieldsOpportunity_update","summary":"Update an Opportunity Custom Field","description":"You can rename it, change its type, change whether it accepts multiple values or not, change whether editing its values is restricted to specific Roles, or update the options for a \"choices\" field type. The updated name will immediately appear in the Close UI and only valid values for the updated `type` will be returned by the Contact API.\n\nSome of the type changes need to convert all of the existing values for a given Custom Field to the new type. When this is required, the response will include an additional `converting_to_type` field. When the conversion is done, `converting_to_type` will no longer be returned.","tags":["custom_fields.opportunity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.opportunity_update_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"customFieldsOpportunity_delete","summary":"Delete an Opportunity Custom Field","description":"Delete an opportunity custom field. The field will immediately disappear from API responses and values on existing opportunities will be permanently removed.","tags":["custom_fields.opportunity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.opportunity_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_field/activity/":{"get":{"operationId":"customFieldsActivity_list","summary":"List Activity Custom Fields","description":"List all the activity custom fields for your organization.","tags":["custom_fields.activity"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.activity_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"customFieldsActivity_create","summary":"Create a new Activity Custom Field","description":"Activity Custom Fields belong to Custom Activities, and have additional attributes:\n\n- `custom_activity_type_id` – the ID of the Custom Activity Type this Field\n  should belong to.\n- `required` – whether the Field will be required to publish the activity.","tags":["custom_fields.activity"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.activity_create_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_field/activity/{id}/":{"get":{"operationId":"customFieldsActivity_get","summary":"Fetch Activity Custom Field's details","tags":["custom_fields.activity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.activity_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"customFieldsActivity_update","summary":"Update an Activity Custom Field","description":"You can rename it, change whether it accepts multiple values or not, change the \"required\" flag, change whether editing its values is restricted to specific Roles, or update the options for a \"choices\" field type. The updated name will immediately appear in the Close UI and only valid values for the updated `type` will be returned by the Custom Activity API.\n\nThe `custom_activity_type_id` and `type` values cannot be changed.","tags":["custom_fields.activity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.activity_update_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"customFieldsActivity_delete","summary":"Delete an Activity Custom Field","description":"Delete an activity custom field. The field will immediately disappear from API responses and values on existing activities will be permanently removed.","tags":["custom_fields.activity"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.activity_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_field/custom_object_type/":{"get":{"operationId":"customFieldsCustomObject_list","summary":"List Custom Object Custom Fields","description":"List all the custom object custom fields for your organization.","tags":["custom_fields.custom_object"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.custom_object_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"customFieldsCustomObject_create","summary":"Create a new Custom Object Custom Field","description":"Custom Object Custom Fields belong to Custom Objects, and have additional attributes:\n\n- `custom_object_type_id` – the ID of the Custom Object Type this Field\n  should belong to.\n- `required` – whether the Field will be required to save the object.","tags":["custom_fields.custom_object"],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.custom_object_create_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_field/custom_object_type/{id}/":{"get":{"operationId":"customFieldsCustomObject_get","summary":"Fetch Custom Object Custom Field's details","tags":["custom_fields.custom_object"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.custom_object_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"customFieldsCustomObject_update","summary":"Update a Custom Object Custom Field","description":"You can rename it, change whether it accepts multiple values or not, change the \"required\" flag, change whether editing its values is restricted to specific Roles, or update the options for a \"choices\" field type. The updated name will immediately appear in the Close UI and only valid values for the updated `type` will be returned by the Custom Object API.\n\nThe `custom_object_type_id` and `type` values cannot be changed.","tags":["custom_fields.custom_object"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.custom_object_update_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"customFieldsCustomObject_delete","summary":"Delete a Custom Object Custom Field","description":"Delete a custom field from a custom object type. The field will immediately disappear from API responses and values on existing custom object instances will be permanently removed.","tags":["custom_fields.custom_object"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_field/shared/":{"get":{"operationId":"customFieldsShared_list","summary":"List Shared Custom Fields","description":"List all the shared custom fields for your organization.","tags":["custom_fields.shared"],"parameters":[{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.shared_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"customFieldsShared_create","summary":"Create a new Shared Custom Field","tags":["custom_fields.shared"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.shared_create_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_field/shared/{id}/":{"get":{"operationId":"customFieldsShared_get","summary":"Fetch Shared Custom Field's details","tags":["custom_fields.shared"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.shared_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"customFieldsShared_update","summary":"Update a Shared Custom Field","description":"You can rename it or update the options for a \"choices\" field type. The updated name will immediately appear in the Close UI and only valid values for the updated `choices` will be returned by the Lead/Contact/Custom Activity APIs.\n\nThe `type` value cannot be changed.","tags":["custom_fields.shared"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.shared_update_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"customFieldsShared_delete","summary":"Delete a Shared Custom Field","description":"Delete a shared custom field and all its associations. The field will immediately disappear from API responses and values on all associated object types will be permanently removed.","tags":["custom_fields.shared"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.shared_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_field/shared/{scf_id}/association/":{"post":{"operationId":"customFieldsShared_createAssociation","summary":"Associate a Shared Custom Field with an object type","description":"Associates a Shared Custom Field with an object type such as Lead, Contact, or Custom Activity Type. Once associated, the Shared Custom Field can be set on objects of that type.\n\nThis endpoint accepts the following attributes:\n\n- `object_type` – can be one of: `lead`, `contact`, `opportunity`, `custom_activity_type`,\n  `custom_object_type`.\n- `custom_activity_type_id` – ID of the Custom Activity Type that you want to\n  associate this Shared Field with. Only relevant if you chose the `object_type` of `custom_activity_type`.\n- `custom_object_type_id` – ID of the Custom Object Type that you want to\n  associate this Shared Field with. Only relevant if you chose the `object_type` of `custom_object_type`.\n- `editable_with_roles` – list of [Roles](https://developer.close.com/api/resources/roles) that can edit the values of\n  this Field on the given object. Note that this is a per-association setting, meaning that editing of the Shared Custom Field can be restricted on one object and not restricted on another.\n- `required` – whether a value *must* be provided for this Field on the given\n  object. Only relevant if you chose the `object_type` of `custom_activity_type` or `custom_object_type`. Note that this is a per-association setting, meaning that this Shared Custom Field can be required on one object and not required on another.","tags":["custom_fields.shared"],"parameters":[{"name":"scf_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.shared_createAssociation_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_field/shared/{scf_id}/association/{object_type}/":{"get":{"operationId":"customFieldsShared_getAssociation","summary":"Fetch a Shared Custom Field Association","tags":["custom_fields.shared"],"parameters":[{"name":"scf_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"object_type","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.shared_getAssociation_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"customFieldsShared_updateAssociation","summary":"Update an existing Shared Custom Field Association","description":"You can change the `required` or the `editable_with_roles` attributes. Everything else cannot be changed.\n\nThe `object_type` in the URL can be either:\n\n- `lead` when editing the association with the Lead object.\n- `contact` when editing the association with the Contact object.\n- `opportunity` when editing the association with the Opportunity object.\n- `custom_activity_type/<catype_id>` when editing the association with a specific\n  Custom Activity Type.\n- `custom_object_type/<cotype_id>` when editing the association with a specific\n  Custom Object Type.","tags":["custom_fields.shared"],"parameters":[{"name":"scf_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"object_type","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_fields.shared_updateAssociation_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"customFieldsShared_deleteAssociation","summary":"Disassociate a Shared Custom Field from an object type","description":"Remove the association between a shared custom field and an object type. The field will immediately disappear from API responses for that object type and all stored values will be permanently deleted.\n\nThe `object_type` in the URL can be `lead`, `contact`, `opportunity`, `custom_activity_type/<catype_id>`, or `custom_object_type/<cotype_id>`.\n\nIf the field was `required` on the associated type, removing the association also removes that requirement.","tags":["custom_fields.shared"],"parameters":[{"name":"scf_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"object_type","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_activity/":{"get":{"operationId":"customActivityTypes_list","summary":"List Custom Activity Types","description":"List all custom activity types defined in the organization. The response includes all Custom Activity Types, including their Custom Field metadata.","tags":["custom_activity_types"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_activity_types_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"customActivityTypes_create","summary":"Create new Custom Activity Type","description":"The type must be created before activity custom fields can be added.","tags":["custom_activity_types"],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_activity_types_create_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_activity/{id}/":{"get":{"operationId":"customActivityTypes_get","summary":"Retrieve a single Custom Activity Type","description":"The response contains the Custom Activity Type including most Custom Field metadata.","tags":["custom_activity_types"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_activity_types_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"customActivityTypes_update","summary":"Update existing Custom Activity Type","description":"The type's `name`, `description`, `api_create_only`, `editable_with_roles` and `is_archived` may be updated here. These properties will be updated immediately in the Custom Activity API.\n\nField order can be set here, but adding, modifying or removing fields from a Custom Activity Type must be done using the Custom Field API. The field order is a display property only, and does not affect the request and response for the Custom Activity API.","tags":["custom_activity_types"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_activity_types_update_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"customActivityTypes_delete","summary":"Delete a Custom Activity Type","tags":["custom_activity_types"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_object_type/":{"get":{"operationId":"customObjectTypes_list","summary":"List Custom Object Types","description":"The response will include all Custom Object Types, including Custom Field metadata for your organization.\n\nEach Custom Object Type has two lists of Custom Fields. The `fields` property contains the list of fields that belong to the Custom Object Type. The `back_reference_fields` property contains the list of any objects (Leads, Contacts, Opportunities, Custom Activities, Custom Objects) that reference the Custom Object Type.","tags":["custom_object_types"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_object_types_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"customObjectTypes_create","summary":"Create new Custom Object Type","description":"The type must be created before Custom Fields can be added.\n\nThe following fields are required:\n  - `name`: The name of the Custom Object Type\n  - `name_plural`: A pluralized version of the name, for some UI display.\n\nThe following fields are optional:\n  - `description`: A longer description of the Custom Object Type.\n  - `api_create_only`: If `true`, instances can only be created by API clients. Defaults to `false`.\n  - `editable_with_roles`: Only users with the given roles can edit instances of this type. By default, any user in your organization can make changes to the instances of this type.","tags":["custom_object_types"],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_object_types_create_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/custom_object_type/{id}/":{"get":{"operationId":"customObjectTypes_get","summary":"Retrieve a single Custom Object Type","description":"Retrieve a single custom object type by ID. The response contains the Custom Object Type including most Custom Field metadata.","tags":["custom_object_types"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_object_types_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"customObjectTypes_update","summary":"Update existing Custom Object Type","description":"The type's `name`, `name_plural`, `description`, `api_create_only` and `editable_with_roles` properties may be updated here. These properties will be updated immediately in the Custom Object API. You cannot add, modify, remove or reorder fields from a Custom Object Type using this resource. See [Custom Object Custom Fields](https://developer.close.com/api/resources/custom-fields/custom-fields-custom-object) and [Custom Field Schema API](https://developer.close.com/api/resources/custom-fields/custom-field-schemas) for these features.","tags":["custom_object_types"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_object_types_update_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"customObjectTypes_delete","summary":"Delete a Custom Object Type","tags":["custom_object_types"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/pipeline/":{"get":{"operationId":"pipelines_list","summary":"List Pipelines for your organization","tags":["pipelines"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pipelines_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"pipelines_create","summary":"Create a Pipeline","tags":["pipelines"],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePipeline"}}}},"security":[{"ApiKeyAuth":[]}]}},"/pipeline/{id}/":{"get":{"operationId":"pipelines_get","summary":"Fetch a single Pipeline","tags":["pipelines"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"pipelines_update","summary":"Update a Pipeline","description":"You can use this endpoint to:\n\n* Rename a Pipeline.\n* Reorder Opportunity Statuses within a Pipeline.\n* Move an Opportunity Status from a different Pipeline into this one.\n    * To do so, include `{\"id\": \"id_of_the_status_from_another_pipeline\"}` in the `statuses` list.","tags":["pipelines"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePipeline"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"pipelines_delete","summary":"Delete a Pipeline","description":"Deletion is only allowed if the Pipeline doesn't contain any Opportunity Statuses. Delete all statuses first or move them to another pipeline.","tags":["pipelines"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/status/opportunity/":{"get":{"operationId":"opportunityStatuses_list","summary":"List opportunity statuses for your organization","tags":["opportunity_statuses"],"parameters":[{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/opportunity_statuses_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"opportunityStatuses_create","summary":"Create an opportunity status","description":"Create a new opportunity status. The status must belong to a pipeline (specified by `pipeline_id`) and have a `type` of `active`, `won`, or `lost`.","tags":["opportunity_statuses"],"parameters":[{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityStatus"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOpportunityStatus"}}}},"security":[{"ApiKeyAuth":[]}]}},"/status/opportunity/{id}/":{"get":{"operationId":"opportunityStatuses_get","summary":"Fetch a single opportunity status","tags":["opportunity_statuses"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityStatus"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"opportunityStatuses_update","summary":"Rename an opportunity status","tags":["opportunity_statuses"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityStatus"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOpportunityStatus"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"opportunityStatuses_delete","summary":"Delete an opportunity status","description":"You should make sure no opportunities are assigned this status, first.","tags":["opportunity_statuses"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/opportunity_statuses_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/status/lead/":{"get":{"operationId":"leadStatuses_list","summary":"List lead statuses for your organization","tags":["lead_statuses"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lead_statuses_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"leadStatuses_create","summary":"Create a new status that can be applied to leads","tags":["lead_statuses"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadStatus"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrUpdateLeadStatus"}}}},"security":[{"ApiKeyAuth":[]}]}},"/status/lead/{id}/":{"get":{"operationId":"leadStatuses_get","summary":"Fetch a single lead status","tags":["lead_statuses"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadStatus"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"leadStatuses_update","summary":"Rename a lead status","description":"Update a lead status. The `label` and `color` can be changed. To update the status of a particular lead, see PUT `/lead/{lead_id}/`.","tags":["lead_statuses"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadStatus"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrUpdateLeadStatus"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"leadStatuses_delete","summary":"Delete a lead status","description":"You should make sure no leads are assigned this status, first.","tags":["lead_statuses"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lead_statuses_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/integration_link/":{"get":{"operationId":"integrationLinks_list","summary":"Get all integration links for your organization","tags":["integration_links"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/integration_links_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"integrationLinks_create","summary":"Create an integration link","tags":["integration_links"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationLink"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIntegrationLink"}}}},"security":[{"ApiKeyAuth":[]}]}},"/integration_link/{id}/":{"get":{"operationId":"integrationLinks_get","summary":"Get a single integration link","tags":["integration_links"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationLink"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"integrationLinks_update","summary":"Update an integration link","tags":["integration_links"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationLink"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIntegrationLink"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"integrationLinks_delete","summary":"Delete an integration link","tags":["integration_links"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/integration_links_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/form/":{"get":{"operationId":"forms_list","summary":"List Forms","description":"List all forms and their published field definitions for your organization.","tags":["forms"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"is_archived","in":"query","description":"Filter by archive status.","required":false,"schema":{"type":"boolean"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/forms_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/form/{id}/":{"get":{"operationId":"forms_fetch","summary":"Retrieve a Form","description":"Retrieve a single form and its published field definitions by ID.","tags":["forms"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Form"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/email_template/":{"get":{"operationId":"emailTemplates_list","summary":"List email templates","tags":["email_templates"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"is_archived","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"is_shared","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_templates_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"emailTemplates_create","summary":"Create an email template","tags":["email_templates"],"parameters":[{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_templates_create_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/email_template/{id}/":{"get":{"operationId":"emailTemplates_get","summary":"Fetch an email template","tags":["email_templates"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}},{"name":"include_embedded","in":"query","description":"Include embedded templates used by Workflows.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_templates_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"emailTemplates_update","summary":"Update an email template","tags":["email_templates"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_templates_update_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"emailTemplates_delete","summary":"Delete an email template","tags":["email_templates"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_templates_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/email_template/{id}/render/":{"get":{"operationId":"emailTemplates_render","summary":"Render an email template","description":"Render an email template for the given lead/contact using the current user context.\n\nAccepts two forms of usage:\n\n- Single lead/contact:\n  - `lead_id` and `contact_id` is supplied (both required)\n- Preview results from a search query\n  - `query` (required) contains a search query\n  - `entry` (optional, ranges from 0 to 99) specifies the index of the lead/contact that should be rendered.\n  - `mode` (optional), which can have a value of:\n     - `lead` (default), the first contact of the lead with the index given by `entry` will be rendered (excluding leads that have no email addresses).\n     - `contact`, then `entry` refers to the index of the contact (excluding contacts that have no emails). Will return an empty dict if there are no more entries.","tags":["email_templates"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"email_account_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"bulk_object_type","in":"query","required":false,"schema":{"$ref":"#/components/schemas/EmailTemplateIdRenderGetParametersBulkObjectType"}},{"name":"contact_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"contact_preference","in":"query","required":false,"schema":{"$ref":"#/components/schemas/EmailTemplateIdRenderGetParametersContactPreference"}},{"name":"entry","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"lead_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"}},{"name":"query","in":"query","required":false,"schema":{"type":"string"}},{"name":"results_limit","in":"query","required":false,"schema":{"type":"integer"}},{"name":"s_query","in":"query","required":false,"schema":{"type":"string"}},{"name":"sender","in":"query","required":false,"schema":{"type":"string","format":"email"}},{"name":"sort","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmailTemplateIdRenderGetParametersSortSchemaItems"}}},{"name":"mode","in":"query","required":false,"schema":{"$ref":"#/components/schemas/EmailTemplateIdRenderGetParametersMode"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_templates_render_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/sms_template/":{"get":{"operationId":"smsTemplates_list","summary":"List SMS templates","tags":["sms_templates"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms_templates_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"smsTemplates_create","summary":"Create an SMS template","tags":["sms_templates"],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms_templates_create_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSMSTemplate"}}}},"security":[{"ApiKeyAuth":[]}]}},"/sms_template/{id}/":{"get":{"operationId":"smsTemplates_get","summary":"Fetch an SMS template","tags":["sms_templates"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"include_attachments","in":"query","description":"Include file attachments in the response.","required":false,"schema":{"type":"boolean","default":false}},{"name":"include_embedded","in":"query","description":"Include embedded templates used by Workflows.","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms_templates_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"smsTemplates_update","summary":"Update an SMS template","tags":["sms_templates"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms_templates_update_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSMSTemplate"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"smsTemplates_delete","summary":"Delete an SMS template","tags":["sms_templates"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/outcome/":{"get":{"operationId":"outcomes_list","summary":"List or filter outcomes","description":"Fetch a list of outcomes.","tags":["outcomes"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/outcomes_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"outcomes_create","summary":"Create an outcome","description":"Create a new outcome for the organization.","tags":["outcomes"],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Outcome"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOutcome"}}}},"security":[{"ApiKeyAuth":[]}]}},"/outcome/{id}/":{"get":{"operationId":"outcomes_get","summary":"Fetch a single outcome","tags":["outcomes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Outcome"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"outcomes_update","summary":"Update an outcome","description":"Update an existing outcome.","tags":["outcomes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Outcome"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOutcome"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"outcomes_delete","summary":"Delete an outcome","description":"Delete an existing outcome.\n\nAll of the calls and/or meetings associated with this outcome will still retain that reference, but you won't be able to set that outcome on any new calls & meetings nor find its definition in the API.","tags":["outcomes"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/outcomes_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/playbook/":{"get":{"operationId":"playbooks_list","summary":"List or filter playbooks","description":"Fetch a list of playbooks for the organization. Results are sorted by position ascending.","tags":["playbooks"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"is_archived","in":"query","description":"Filter for archived or not-archived playbooks. When not provided, both archived and not-archived playbooks will be returned.","required":false,"schema":{"type":["boolean","null"],"default":null}},{"name":"position__gt","in":"query","description":"Filters for where the playbook's `position` is greater than the given value.","required":false,"schema":{"type":["integer","null"],"default":null}},{"name":"created_at__lt","in":"query","description":"Filters for where the playbook's `created_at` (creation date) is before the given value.","required":false,"schema":{"type":["string","null"],"format":"date-time","default":null}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/playbooks_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"playbooks_create","summary":"Create a playbook","description":"Create a new playbook for the organization.","tags":["playbooks"],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Playbook"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePlaybook"}}}},"security":[{"ApiKeyAuth":[]}]}},"/playbook/{id}/":{"get":{"operationId":"playbooks_get","summary":"Fetch a single playbook","tags":["playbooks"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Playbook"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"playbooks_update","summary":"Update a playbook","description":"Update an existing playbook.","tags":["playbooks"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Playbook"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePlaybook"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"playbooks_delete","summary":"Delete a playbook","description":"Delete an existing playbook.","tags":["playbooks"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/playbook/{id}/archive/":{"post":{"operationId":"playbooks_archive","summary":"Archive a playbook","description":"Archive an existing playbook. Archived playbooks are hidden from active listings but retain their associated history.","tags":["playbooks"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Playbook"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/playbook/{id}/unarchive/":{"post":{"operationId":"playbooks_unarchive","summary":"Unarchive a playbook","description":"Restore a previously archived playbook to active status.","tags":["playbooks"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Playbook"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/scheduling_link/":{"get":{"operationId":"schedulingLinks_list","summary":"List User Scheduling Links","tags":["scheduling_links"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scheduling_links_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"schedulingLinks_create","summary":"Create a User Scheduling Link","tags":["scheduling_links"],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scheduling_links_create_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/scheduling_link/integration/":{"post":{"operationId":"schedulingLinks_createIntegration","summary":"Create or update a Scheduling Link via OAuth","description":"Please note that only OAuth apps can perform this operation. Using API key will result in an error. See [Authentication with OAuth](https://developer.close.com/api/overview/oauth-authentication) for more information.\n\nCreate or update a user scheduling link, managed by your application. Uses the integration-provided `source_id` field to identify and merge duplicate resources created by the same OAuth Application. If a scheduling link created by your OAuth application with the specified `source_id` does not exist, a new one will be created. Otherwise, the scheduling link resource will be updated. Requires authentication via OAuth.","tags":["scheduling_links"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scheduling_links_createIntegration_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/scheduling_link/integration/{source_id}/":{"delete":{"operationId":"schedulingLinks_deleteIntegration","summary":"Delete a User Scheduling Link via OAuth integration","description":"Please note that only OAuth apps can perform this operation. Using API key will result in an error. See [Authentication with OAuth](https://developer.close.com/api/overview/oauth-authentication) for more information.\n\nUses the `source_id` field to identify and delete the specified User Scheduling Link created by your OAuth Application.","tags":["scheduling_links"],"parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/scheduling_link/{id}/":{"get":{"operationId":"schedulingLinks_get","summary":"Fetch a User Scheduling Link","tags":["scheduling_links"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scheduling_links_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"schedulingLinks_update","summary":"Update a User Scheduling Link","tags":["scheduling_links"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scheduling_links_update_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"schedulingLinks_delete","summary":"Delete a User Scheduling Link","tags":["scheduling_links"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/shared_scheduling_link/":{"get":{"operationId":"schedulingLinks_listShared","summary":"List Shared Scheduling Links","tags":["scheduling_links"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scheduling_links_listShared_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"schedulingLinks_createShared","summary":"Create a Shared Scheduling Link","tags":["scheduling_links"],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scheduling_links_createShared_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/shared_scheduling_link/{id}/":{"get":{"operationId":"schedulingLinks_getShared","summary":"Fetch a Shared Scheduling Link","tags":["scheduling_links"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scheduling_links_getShared_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"schedulingLinks_updateShared","summary":"Update a Shared Scheduling Link","tags":["scheduling_links"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scheduling_links_updateShared_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"schedulingLinks_deleteShared","summary":"Delete a Shared Scheduling Link","tags":["scheduling_links"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/shared_scheduling_link_association/":{"post":{"operationId":"schedulingLinks_createSharedAssociation","summary":"Map a Shared Scheduling Link","description":"Map a Shared Scheduling Link to either a User Scheduling Link or a URL.\n\nSee the examples below for both mapping options.","tags":["scheduling_links"],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scheduling_links_createSharedAssociation_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/shared_scheduling_link_association/unmap/":{"post":{"operationId":"schedulingLinks_deleteSharedAssociation","summary":"Unmap a Shared Scheduling Link","tags":["scheduling_links"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/scheduling_links_deleteSharedAssociation_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/connected_account/":{"get":{"operationId":"connectedAccounts_list","summary":"List connected accounts","description":"You can filter down to a specific user by passing the `?user_id` query parameter.","tags":["connected_accounts"],"parameters":[{"name":"_fields","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"default":["_type","available_calendars","available_features","calendar_receive_status","calendly","date_created","default_identity","email","email_receive_status","enabled_features","has_meeting_creation_scopes","id","identities","imap","is_imap_archive_sync_enabled","label","latest_receive_error","latest_send_error","lead_suggestions_updated_at","organization_id","receive_status","send_status","smtp","sync_all_calendars","synced_calendars","user_id","zoom_account_plan"]}},{"name":"user_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connected_accounts_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/connected_account/{id}/":{"get":{"operationId":"connectedAccounts_get","summary":"Fetch a single connected account","tags":["connected_accounts"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"default":["_type","available_calendars","available_features","calendar_receive_status","calendly","date_created","default_identity","email","email_receive_status","enabled_features","has_meeting_creation_scopes","id","identities","imap","is_imap_archive_sync_enabled","label","latest_receive_error","latest_send_error","lead_suggestions_updated_at","organization_id","receive_status","send_status","smtp","sync_all_calendars","synced_calendars","user_id","zoom_account_plan"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connected_accounts_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/send_as/":{"get":{"operationId":"sendAs_list","summary":"List Send As Associations","description":"A user only has access to associations they are involved in. This means that when using this endpoint, `allowing_user_id` or `allowed_user_id` must be equal to your user ID. If neither filter is provided, `allowing_user_id` is assumed by default.","tags":["send_as"],"parameters":[{"name":"allowed_user_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"allowing_user_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/send_as_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"sendAs_create","summary":"Create a Send As Association","description":"Create a send-as permission. The `allowing_user_id` must be equal to your own user ID.","tags":["send_as"],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/send_as_create_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"sendAs_deleteByUser","summary":"Delete a Send As Association by allowed user","description":"The `allowing_user_id` must be equal to your user ID.\n\nSupply both the `allowing_user_id` and the `allowed_user_id` to delete an association by those users.","tags":["send_as"],"parameters":[{"name":"allowed_user_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"allowing_user_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/send_as/bulk/":{"post":{"operationId":"sendAs_bulkCreate","summary":"Edit Send As Associations in bulk","description":"You can allow and disallow many other users to send as you in a single command by supplying the user IDs you want to allow and disallow.\n\nOnce completed, this endpoint returns all existing associations where your user is the allowing user.","tags":["send_as"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/send_as_bulkCreate_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/send_as/{id}/":{"get":{"operationId":"sendAs_get","summary":"Retrieve a single Send As Association","tags":["send_as"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/send_as_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"sendAs_delete","summary":"Delete a Send As Association by ID","tags":["send_as"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/unsubscribe/email/":{"get":{"operationId":"unsubscribedEmails_list","summary":"List all unsubscribed emails","description":"Get a list of unsubscribed email addresses.","tags":["unsubscribed_emails"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/unsubscribed_emails_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"unsubscribedEmails_create","summary":"Unsubscribe an email address","description":"This is useful for when you have an email address that has unsubscribed in another context (like a mailing list) and you want to unsubscribe them from messages from Close as well.","tags":["unsubscribed_emails"],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/unsubscribed_emails_create_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUnsubscribedEmail"}}}},"security":[{"ApiKeyAuth":[]}]}},"/unsubscribe/email/{email_address}/":{"delete":{"operationId":"unsubscribedEmails_delete","summary":"Resubscribe an email address","tags":["unsubscribed_emails"],"parameters":[{"name":"email_address","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/unsubscribed_emails_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/phone_number/":{"get":{"operationId":"phoneNumbers_list","summary":"List or search for phone numbers","tags":["phone_numbers"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}},{"name":"number","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"user_id","in":"query","description":"Deprecated. Use `participant_user_id` instead. The distinction between personal and group numbers is being removed, and `user_id` will be removed in a future update.","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"is_group_number","in":"query","description":"Deprecated. Use `participant_user_id` instead. The distinction between personal and group numbers is being removed, and `is_group_number` will be removed in a future update.","required":false,"schema":{"type":["boolean","null"],"default":null}},{"name":"participant_user_id","in":"query","description":"Return numbers the given user participates in, including both personal and group numbers they belong to.","required":false,"schema":{"type":["string","null"],"default":null}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phone_numbers_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/phone_number/request/internal/":{"post":{"operationId":"phoneNumbers_create","summary":"Request an internal phone number","description":"Renting a phone number incurs a cost. You need the \"Manage Team Phone Numbers\" permission to rent group numbers.\n\nIf a number was rented, a 201 response is returned with the new number. If no number was rented (4xx response code), the response contains a `status` field which may contain one of the values below. New statuses may be added in the future.\n\n* `has-voice-only`: This country/prefix combination only has non-SMS-capable\n  numbers. You can attempt renting the number by passing `with_sms` as `false`.\n* `needs-more-info`: More information (such as proof of address) is needed to\n  rent this number. This number can only be rented by contacting Close support.\n* `billing-error`: An error related to billing has occurred. For example, the\n  telephony budget has been reached, or there are not enough funds and recharging failed.\n* `error`: An error has occurred while renting this number. A human-readable\n  message is returned in the `error` field.","tags":["phone_numbers"],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phone_numbers_create_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePhoneNumberRequest"}}}},"security":[{"ApiKeyAuth":[]}]}},"/phone_number/{id}/":{"get":{"operationId":"phoneNumbers_get","summary":"Retrieve a single phone number","tags":["phone_numbers"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumber"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"phoneNumbers_update","summary":"Update a phone number","description":"You need the \"Manage Team Phone Numbers\" permission to update a group number. You can only update your own personal numbers.\n\nYou can:\n\n- Change a `label` of your number.\n- Set up call forwarding via `forward_to` and `forward_to_enabled`.\n- Set up a voicemail greeting by including a URL of an mp3 recording in `voicemail_greeting_url`. We require the URL to be secure (i.e. starting with https://).\n- Modify which team members are part of a group number via `participants`. This should be a list of user IDs.\n- Modify which external phone numbers are part of a group number via `phone_numbers`. This should be a list of phone numbers in E.164 international format, e.g. \"+16503334444\".\n- Change how long (in seconds, 15-90) the number rings on inbound calls before moving on (e.g. to voicemail) via `inbound_ring_duration`.","tags":["phone_numbers"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhoneNumber"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePhoneNumber"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"phoneNumbers_delete","summary":"Delete a phone number","description":"You need the \"Manage Team Phone Numbers\" permission to delete a group number. You can only delete your own personal numbers.","tags":["phone_numbers"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/phone_numbers_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/blocked_phone_number/":{"get":{"operationId":"blockedPhoneNumbers_list","summary":"List Blocked Phone Numbers","tags":["blocked_phone_numbers"],"parameters":[{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/blocked_phone_numbers_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"blockedPhoneNumbers_create","summary":"Create a Blocked Phone Number","description":"Once this record is created, the phone number you have specified will no longer work for outbound nor inbound calls. That means:\n\n* Nobody in your organization will be able to call that phone number.\n* That phone number will not be able to call anybody in your organization.","tags":["blocked_phone_numbers"],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockedPhoneNumber"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockedPhoneNumber"}}}},"security":[{"ApiKeyAuth":[]}]}},"/blocked_phone_number/settings/":{"get":{"operationId":"blockedPhoneNumbers_getSettings","summary":"Retrieve Blocked Phone Number settings","tags":["blocked_phone_numbers"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockedPhoneNumberSettings"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"blockedPhoneNumbers_updateSettings","summary":"Update Blocked Phone Number settings","tags":["blocked_phone_numbers"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockedPhoneNumberSettings"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockedPhoneNumberSettings"}}}},"security":[{"ApiKeyAuth":[]}]}},"/blocked_phone_number/{id}/":{"get":{"operationId":"blockedPhoneNumbers_get","summary":"Retrieve a single Blocked Phone Number","tags":["blocked_phone_numbers"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockedPhoneNumber"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"blockedPhoneNumbers_update","summary":"Update a Blocked Phone Number","tags":["blocked_phone_numbers"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockedPhoneNumber"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockedPhoneNumber"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"blockedPhoneNumbers_delete","summary":"Delete a Blocked Phone Number","description":"Once the given Blocked Phone Number record is deleted, the specified \"\n\"phone number will again be able to make calls into your organization \"\n\"and you'll be able to make calls to it.","tags":["blocked_phone_numbers"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/dialer/":{"get":{"operationId":"dialers_list","summary":"List or filter all dialer sessions","tags":["dialers"],"parameters":[{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"source_type","in":"query","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/DialerGetParametersSourceTypeSchema"},{"type":"null"}],"default":null}},{"name":"source_value","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"status","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"status__in","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"user_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}},{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dialers_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/dialer/{id}/":{"get":{"operationId":"dialers_get","summary":"Get a single dialer session","description":"Once you have a `source_value` for a dialer session and `source_type=saved-search`, you can use the [saved_search endpoint](https://developer.close.com/api/resources/smart-views/get) to find out more information about the Smart View being used.","tags":["dialers"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"organization_id","in":"query","required":false,"schema":{"type":["string","null"],"default":null}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dialers_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/me/":{"get":{"operationId":"users_getMe","summary":"Fetch information about yourself","description":"A special instance of the Users endpoint for the current user. Useful for determining your own `id` and `organization_id`.","tags":["users"],"parameters":[{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/users_getMe_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/user/":{"get":{"operationId":"users_list","summary":"List users in your organization","description":"List all users who are members of your organization.","tags":["users"],"parameters":[{"name":"_order_by","in":"query","required":false,"schema":{"$ref":"#/components/schemas/UserGetParametersOrderBy"}},{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/users_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/user/availability/":{"get":{"operationId":"users_listAvailabilities","summary":"List user availability statuses","description":"List user availability statuses for all users in an organization.\n\nThe `active_calls` field is an array of call metadata for calls that the user is currently participating in.","tags":["users"],"parameters":[{"name":"organization_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/users_listAvailabilities_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/user/{id}/":{"get":{"operationId":"users_get","summary":"Fetch a single user","tags":["users"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_order_by","in":"query","required":false,"schema":{"$ref":"#/components/schemas/UserIdGetParametersOrderBy"}},{"name":"_limit","in":"query","description":"Number of results to return.","required":false,"schema":{"type":"integer","default":100}},{"name":"_skip","in":"query","description":"Number of results to skip before returning, for pagination.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/users_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/organization/{id}/":{"get":{"operationId":"organizations_get","summary":"Get an organization's details","description":"By default, `memberships` and `inactive_memberships` are populated with user data prefixed with `user_`. If you'd rather have a nested `user` field, use a query string like `?_expand=memberships__user,inactive_memberships__user`.","tags":["organizations"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_expand","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"organizations_update","summary":"Update an organization","tags":["organizations"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_expand","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations_update_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"security":[{"ApiKeyAuth":[]}]}},"/membership/":{"post":{"operationId":"memberships_create","summary":"Create a membership","description":"Ensures an active membership for the given email will be provisioned.\n\n- If the user already exists, they will be added to the requestor's organization.\n- If it doesn't exist, a new user will be provisioned.\n\nThis request requires \"Manage Organization\" permissions.\n\nAs a security precaution, this operation requires the organization to have the\n\"Restrict new users to emails from these domains\" setting enabled, and the new\nmember's email address must belong to one of its verified domains.","tags":["memberships"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipResponse"}}}},"400":{"description":"Invalid membership data, including an email address that does not belong to one of the organization's verified domains.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"Membership creation is not permitted because the requestor cannot manage the organization, the verified domain restriction is disabled, or the requested role grants the `manage_organization` permission.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMembership"}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"memberships_bulkUpdate","summary":"Bulk update memberships","description":"Any field that can be updated on a membership individually can also be used to bulk update multiple memberships. Pass the comma-separated ids of the memberships to update into `id__in` in `_params`. For example:\n\n```json\n{\"_params\": {\"id__in\": \"memb_A,memb_B\"}, \"role_id\": \"role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p\"}\n```","tags":["memberships"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/memberships_bulkUpdate_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Membership"}}}},"security":[{"ApiKeyAuth":[]}]}},"/membership/{id}/":{"put":{"operationId":"memberships_update","summary":"Update a membership","tags":["memberships"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Membership"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"memberships_delete","summary":"Delete a membership","description":"Deactivates a membership, removing the user from the associated organization.","tags":["memberships"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/memberships_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/membership/{id}/pinned_views/":{"get":{"operationId":"memberships_getPinnedViews","summary":"Get pinned views for a membership","description":"Get the ordered list of pinned views for the given membership.","tags":["memberships"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/memberships_getPinnedViews_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"memberships_updatePinnedViews","summary":"Update pinned views for a membership","description":"Set the pinned views for the given membership. Provide an ordered list that will overwrite the entire current list.","tags":["memberships"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/memberships_updatePinnedViews_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPinnedSavedView"}}}},"security":[{"ApiKeyAuth":[]}]}},"/role/":{"get":{"operationId":"roles_list","summary":"List all the roles defined for your organization","tags":["roles"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/roles_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"roles_create","summary":"Create a new role","description":"`visibility_user_lcf_ids` (optional)\n\nA list of Lead Custom Field IDs that define which leads user with this role can see. If the role has `view_all_leads` permission, this field should be empty.\n\n`visibility_user_lcf_behavior` (optional)\n\nDefines how lead visibility works for leads that don't have assigned users. If the role has `view_all_leads` permission, this field should be empty.\n\n - `require_assignment` - leads without assigned users are not visible to this role\n - `allow_unassigned` - leads without assigned users are visible to this role","tags":["roles"],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/roles_create_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]}},"/role/{id}/":{"get":{"operationId":"roles_get","summary":"Fetch a single role","tags":["roles"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/roles_get_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"roles_update","summary":"Update existing role","tags":["roles"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/roles_update_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"description":"Any type"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"roles_delete","summary":"Delete a role","description":"Delete a custom role. You must first move all users off this role by reassigning them to another role.","tags":["roles"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/roles_delete_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/group/":{"get":{"operationId":"groups_list","summary":"List Groups for your organization","description":"Note that list endpoint does not support retrieving members for all groups. Use individual group endpoint instead.","tags":["groups"],"parameters":[{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_list_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"post":{"operationId":"groups_create","summary":"Create a Group","description":"Create a new group. The `name` is required and must be unique within the organization. The group is created with no members. Use the member endpoint to add users.","tags":["groups"],"parameters":[{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroup"}}}},"security":[{"ApiKeyAuth":[]}]}},"/group/{group_id}/member/":{"post":{"operationId":"groups_addMember","summary":"Add a User to a Group","description":"Add a user to a group by providing the `user_id`. If the user is already a member, nothing changes.","tags":["groups"],"parameters":[{"name":"group_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupMember"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupMember"}}}},"security":[{"ApiKeyAuth":[]}]}},"/group/{group_id}/member/{user_id}/":{"delete":{"operationId":"groups_removeMember","summary":"Remove a User from a Group","description":"If the user is not a member of the group, nothing changes.","tags":["groups"],"parameters":[{"name":"group_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/group/{id}/":{"get":{"operationId":"groups_get","summary":"Fetch an individual Group","tags":["groups"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]},"put":{"operationId":"groups_update","summary":"Update a Group","description":"You can use this endpoint to rename a Group. If a name is not unique, an error will be returned.","tags":["groups"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"_fields","in":"query","description":"Comma-separated list of fields to include in the response.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroup"}}}},"security":[{"ApiKeyAuth":[]}]},"delete":{"operationId":"groups_delete","summary":"Delete a Group","description":"Delete a group. Members will be removed from the group but not from the organization. Deletion is only allowed if the group is not referenced by saved reports or smart views.","tags":["groups"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"ApiKeyAuth":[]}]}}},"tags":[{"name":"leads"},{"name":"contacts"},{"name":"opportunities"},{"name":"tasks"},{"name":"files"},{"name":"custom_objects"},{"name":"comments"},{"name":"activities"},{"name":"activities.notes"},{"name":"activities.calls"},{"name":"activities.emails"},{"name":"activities.email_threads"},{"name":"activities.sms"},{"name":"activities.whatsapp_messages"},{"name":"activities.meetings"},{"name":"activities.custom_activities"},{"name":"activities.creations"},{"name":"activities.form_submissions"},{"name":"activities.lead_status_changes"},{"name":"activities.opportunity_status_changes"},{"name":"activities.lead_merges"},{"name":"activities.task_completions"},{"name":"activities.import_updates"},{"name":"webhooks"},{"name":"events"},{"name":"smart_views"},{"name":"reporting"},{"name":"sequences"},{"name":"bulk_actions.email"},{"name":"bulk_actions.edit"},{"name":"bulk_actions.delete"},{"name":"bulk_actions.sequence_subscriptions"},{"name":"exports"},{"name":"field_enrichment"},{"name":"custom_field_schemas"},{"name":"custom_fields.lead"},{"name":"custom_fields.contact"},{"name":"custom_fields.opportunity"},{"name":"custom_fields.activity"},{"name":"custom_fields.custom_object"},{"name":"custom_fields.shared"},{"name":"custom_activity_types"},{"name":"custom_object_types"},{"name":"pipelines"},{"name":"opportunity_statuses"},{"name":"lead_statuses"},{"name":"integration_links"},{"name":"forms"},{"name":"email_templates"},{"name":"sms_templates"},{"name":"outcomes"},{"name":"playbooks"},{"name":"scheduling_links"},{"name":"connected_accounts"},{"name":"send_as"},{"name":"unsubscribed_emails"},{"name":"phone_numbers"},{"name":"blocked_phone_numbers"},{"name":"dialers"},{"name":"users"},{"name":"organizations"},{"name":"memberships"},{"name":"roles"},{"name":"groups"}],"servers":[{"url":"https://api.close.com/api/v1","description":"https://api.close.com/api/v1"}],"components":{"schemas":{"LeadAddress":{"type":"object","properties":{"address_1":{"type":["string","null"]},"address_2":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":["string","null"]},"label":{"type":["string","null"]},"state":{"type":["string","null"]},"tz_ids":{"type":"array","items":{"type":"string"}},"zipcode":{"type":["string","null"]}},"required":["address_1","address_2","city","country","label","state","zipcode"],"title":"LeadAddress"},"ContactEmail":{"type":"object","properties":{"email":{"type":"string"},"is_unsubscribed":{"type":"boolean"},"type":{"type":"string"}},"required":["email","is_unsubscribed","type"],"title":"ContactEmail"},"RenderedIntegrationLink":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}},"required":["name","url"],"title":"RenderedIntegrationLink"},"ContactPhone":{"type":"object","properties":{"country":{"type":["string","null"]},"outbound_sms_blocked":{"type":"boolean"},"phone":{"type":"string"},"phone_formatted":{"type":"string"},"type":{"type":"string"},"tz_ids":{"type":"array","items":{"type":"string"}}},"required":["phone","type"],"title":"ContactPhone"},"CallStatus":{"type":"string","enum":["created","in-progress","completed","cancel","no-answer","busy","failed","timeout"],"description":"Current status of the call.","title":"CallStatus"},"ContactRecentCall":{"type":"object","properties":{"dialer_id":{"type":["string","null"]},"duration":{"type":"integer"},"finish_timestamp":{"type":"string","format":"date-time"},"id":{"type":"string"},"status":{"$ref":"#/components/schemas/CallStatus"}},"required":["dialer_id","duration","finish_timestamp","id","status"],"title":"ContactRecentCall"},"WorkflowStatus":{"type":"string","enum":["active","paused","draft"],"title":"WorkflowStatus"},"WorkflowRunStatus":{"type":"string","enum":["active","paused","finished","goal","error"],"title":"WorkflowRunStatus"},"StatusReason":{"type":"string","enum":["manual","pending-call-timed-out","bulk-action","rate-limited","sequence-deleted","workflow-paused","filter-not-matched","insufficient-ai-credit-balance","plan-not-supported","reply-received","call-answered","meeting-booked","lead-status-changed","outcome-met","account-invalid","account-failures","sending-throttled-too-long","membership-inactive","send-as-error","email-bounced","call-failed","sms-failed","no-user-phone","billing-error","assignment-field-invalid","lead-status-field-invalid","assignees-missing","run-as-disabled","lead-not-visible","internal-error","field-mapping-error","filter-config-invalid","email-ai-generation-failed"],"description":"Reason for each higher level status on a Workflow run.","title":"StatusReason"},"BasicSubscriptionInfoForContact":{"type":"object","properties":{"contact_email":{"type":["string","null"]},"date_created":{"type":"string","format":"date-time"},"initial_email_id":{"type":["string","null"]},"sequence_id":{"type":"string"},"sequence_name":{"type":"string"},"sequence_status":{"$ref":"#/components/schemas/WorkflowStatus"},"start_date":{"type":["string","null"],"format":"date-time"},"subscription_id":{"type":"string"},"subscription_status":{"$ref":"#/components/schemas/WorkflowRunStatus"},"subscription_status_reason":{"oneOf":[{"$ref":"#/components/schemas/StatusReason"},{"type":"null"}]}},"required":["contact_email","date_created","initial_email_id","sequence_id","sequence_name","sequence_status","start_date","subscription_id","subscription_status","subscription_status_reason"],"title":"BasicSubscriptionInfoForContact"},"ContactUrl":{"type":"object","properties":{"type":{"type":"string"},"url":{"type":"string"}},"required":["type","url"],"title":"ContactUrl"},"Contact":{"type":"object","properties":{"created_by":{"type":["string","null"]},"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"display_name":{"type":"string"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/ContactEmail"}},"id":{"type":"string"},"integration_links":{"type":"array","items":{"$ref":"#/components/schemas/RenderedIntegrationLink"}},"lead_id":{"type":["string","null"],"default":null},"lead_suggestions_operation_id":{"type":["string","null"]},"name":{"type":["string","null"]},"organization_id":{"type":"string"},"phones":{"type":"array","items":{"$ref":"#/components/schemas/ContactPhone"}},"recent_calls":{"type":"array","items":{"$ref":"#/components/schemas/ContactRecentCall"}},"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/BasicSubscriptionInfoForContact"}},"timezone":{"type":["string","null"]},"timezone_source":{"type":["string","null"]},"title":{"type":["string","null"]},"updated_by":{"type":["string","null"]},"urls":{"type":"array","items":{"$ref":"#/components/schemas/ContactUrl"}}},"required":["created_by","date_created","date_updated","display_name","id","name","organization_id","title","updated_by"],"title":"Contact"},"Attachment":{"type":"object","properties":{"content_type":{"type":["string","null"]},"filename":{"type":["string","null"]},"size":{"type":["integer","null"]},"thumbnail_url":{"type":["string","null"]},"url":{"type":"string"}},"required":["content_type","filename","size","url"],"title":"Attachment"},"CommentSummary":{"type":"object","properties":{"comment_count":{"type":"integer"},"thread_id":{"type":"string"}},"required":["comment_count","thread_id"],"title":"CommentSummary"},"StalledOpportunityCommunicationIssue":{"type":"string","enum":["no_issue","cant_get_in_touch","no_communication_attempts"],"title":"StalledOpportunityCommunicationIssue"},"StalledOpportunityActionTypeV1":{"type":"string","enum":["mark_as_lost","change_status","follow_up","adjust_close_date","ask_someone_else_to_reach_out","change_communication_method"],"title":"StalledOpportunityActionTypeV1"},"ActionItem":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/StalledOpportunityActionTypeV1","description":"The recommended next step to progress or resolve the stalled opportunity"},"justification":{"type":"string","description":"A short justification for the recommended action in the sales pipeline. Maximum 2 sentences."}},"required":["action","justification"],"title":"ActionItem","deprecated":true},"StalledOpportunityActionItems":{"type":"object","properties":{"communication_issue":{"$ref":"#/components/schemas/StalledOpportunityCommunicationIssue","description":"The communication issue that is causing the stalled opportunity. If there is no issue, set to NoIssue."},"next_action":{"$ref":"#/components/schemas/ActionItem","description":"An action item recommended to progress or resolve the stalled opportunity.","deprecated":true}},"required":["communication_issue","next_action"],"title":"StalledOpportunityActionItems","deprecated":true},"OpportunityStatusType":{"type":"string","enum":["won","lost","active"],"title":"OpportunityStatusType"},"StalledOpportunityActionTypeV2":{"type":"string","enum":["change_status","adjust_close_date","follow_up_email","follow_up_call","follow_up_sms"],"title":"StalledOpportunityActionTypeV2"},"OpportunityChangeStatusActionDetails":{"type":"object","properties":{"status_id":{"type":"string"}},"required":["status_id"],"title":"OpportunityChangeStatusActionDetails"},"OpportunityFollowUpEmailActionDetails":{"type":"object","properties":{"contact_id":{"type":"string"},"message_draft":{"type":"string"},"subject_draft":{"type":"string"}},"required":["contact_id","message_draft","subject_draft"],"title":"OpportunityFollowUpEmailActionDetails"},"OpportunityFollowUpSMSActionDetails":{"type":"object","properties":{"contact_id":{"type":"string"},"message_draft":{"type":"string"}},"required":["contact_id","message_draft"],"title":"OpportunityFollowUpSMSActionDetails"},"OpportunityFollowUpCallActionDetails":{"type":"object","properties":{"call_plan":{"type":"string"},"contact_id":{"type":"string"}},"required":["call_plan","contact_id"],"title":"OpportunityFollowUpCallActionDetails"},"OpportunityAdjustCloseDateActionDetails":{"type":"object","properties":{"close_date":{"type":"string","format":"date"}},"required":["close_date"],"title":"OpportunityAdjustCloseDateActionDetails"},"OpportunitySuggestedActionDetails":{"oneOf":[{"$ref":"#/components/schemas/OpportunityChangeStatusActionDetails"},{"$ref":"#/components/schemas/OpportunityFollowUpEmailActionDetails"},{"$ref":"#/components/schemas/OpportunityFollowUpSMSActionDetails"},{"$ref":"#/components/schemas/OpportunityFollowUpCallActionDetails"},{"$ref":"#/components/schemas/OpportunityAdjustCloseDateActionDetails"}],"title":"OpportunitySuggestedActionDetails"},"OpportunitySuggestedAction":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/StalledOpportunityActionTypeV2"},"details":{"oneOf":[{"$ref":"#/components/schemas/OpportunitySuggestedActionDetails"},{"type":"null"}]},"justification":{"type":"string"}},"required":["action","details","justification"],"title":"OpportunitySuggestedAction"},"OpportunityValuePeriod":{"type":"string","enum":["one_time","monthly","annual"],"title":"OpportunityValuePeriod"},"Opportunity":{"type":"object","properties":{"annualized_expected_value":{"type":["integer","null"]},"annualized_value":{"type":["integer","null"]},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}},"comment_summary":{"oneOf":[{"$ref":"#/components/schemas/CommentSummary"},{"type":"null"}]},"confidence":{"type":"integer"},"contact_id":{"type":["string","null"]},"contact_name":{"type":["string","null"]},"created_by":{"type":["string","null"]},"created_by_name":{"type":["string","null"]},"date_created":{"type":"string","format":"date-time"},"date_lost":{"type":["string","null"],"format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"date_won":{"type":["string","null"],"format":"date"},"expected_value":{"type":["integer","null"]},"id":{"type":"string"},"integration_links":{"type":"array","items":{"$ref":"#/components/schemas/RenderedIntegrationLink"}},"is_stalled":{"type":"boolean"},"lead_id":{"type":"string"},"lead_name":{"type":["string","null"]},"lead_primary_email":{"oneOf":[{"$ref":"#/components/schemas/ContactEmail"},{"type":"null"}]},"lead_primary_phone":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ContactPhone"}},"note":{"type":["string","null"]},"note_html":{"type":["string","null"]},"organization_id":{"type":"string"},"pipeline_id":{"type":["string","null"]},"pipeline_name":{"type":["string","null"]},"stall_status":{"oneOf":[{"$ref":"#/components/schemas/StalledOpportunityActionItems"},{"type":"null"}],"deprecated":true},"status_display_name":{"type":"string"},"status_id":{"type":"string"},"status_label":{"type":"string"},"status_type":{"$ref":"#/components/schemas/OpportunityStatusType"},"suggested_action":{"oneOf":[{"$ref":"#/components/schemas/OpportunitySuggestedAction"},{"type":"null"}]},"updated_by":{"type":["string","null"]},"updated_by_name":{"type":["string","null"]},"user_id":{"type":"string"},"user_name":{"type":["string","null"]},"value":{"type":["integer","null"]},"value_currency":{"type":["string","null"]},"value_formatted":{"type":["string","null"]},"value_period":{"$ref":"#/components/schemas/OpportunityValuePeriod"}},"required":["annualized_expected_value","annualized_value","confidence","contact_id","created_by","date_created","date_lost","date_updated","date_won","expected_value","id","lead_id","note","note_html","organization_id","status_id","updated_by","user_id","value","value_period"],"title":"Opportunity"},"Lead":{"type":"object","properties":{"addresses":{"type":"array","items":{"$ref":"#/components/schemas/LeadAddress"}},"contact_ids":{"type":"array","items":{"type":"string"}},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/Contact"},"deprecated":true},"contacts_summary":{"type":"string"},"created_by":{"type":["string","null"]},"created_by_name":{"type":["string","null"]},"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"description":{"type":["string","null"]},"display_name":{"type":"string"},"html_url":{"type":"string"},"id":{"type":"string"},"integration_links":{"type":"array","items":{"$ref":"#/components/schemas/RenderedIntegrationLink"}},"localtime":{"type":["string","null"],"format":"date-time"},"name":{"type":["string","null"]},"opportunities":{"type":"array","items":{"$ref":"#/components/schemas/Opportunity"},"deprecated":true},"organization_id":{"type":"string"},"primary_address_full":{"type":["string","null"]},"primary_address_summary":{"type":["string","null"]},"primary_email":{"oneOf":[{"$ref":"#/components/schemas/ContactEmail"},{"type":"null"}]},"primary_phone":{"oneOf":[{"$ref":"#/components/schemas/ContactPhone"},{"type":"null"}]},"recent_calls":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}}},"source":{"type":["string","null"]},"status_id":{"type":"string"},"status_label":{"type":"string"},"summaries":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}}},"tasks":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}}},"updated_by":{"type":["string","null"]},"updated_by_name":{"type":["string","null"]},"url":{"type":["string","null"]}},"required":["contact_ids","created_by","date_created","date_updated","description","html_url","id","name","organization_id","status_id","updated_by","url"],"title":"Lead"},"leads_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Lead"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"leads_list_Response_200"},"leads_merge_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"leads_merge_Response_200"},"leads_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"leads_delete_Response_200"},"LeadFile":{"type":"object","properties":{"checksum":{"type":"string"},"content_type":{"type":"string"},"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"download_url":{"type":"string"},"id":{"type":"string"},"is_pinned":{"type":"boolean"},"last_activity_at":{"type":"string","format":"date-time"},"last_object_id":{"type":"string"},"last_object_type":{"type":"string"},"lead_id":{"type":"string"},"name":{"type":"string"},"organization_id":{"type":"string"},"size":{"type":"integer"},"thumbnail_url":{"type":["string","null"]},"updated_by":{"type":["string","null"]}},"required":["checksum","content_type","date_created","date_updated","download_url","id","is_pinned","last_activity_at","last_object_id","last_object_type","lead_id","name","organization_id","size","thumbnail_url","updated_by"],"title":"LeadFile"},"leads_filesList_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LeadFile"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"leads_filesList_Response_200"},"CreateLeadFile":{"type":"object","properties":{"content_type":{"type":"string","minLength":1,"maxLength":255},"filename":{"type":"string","minLength":1,"maxLength":1024},"url":{"type":"string","minLength":1}},"required":["content_type","filename","url"],"title":"CreateLeadFile"},"contacts_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"contacts_list_Response_200"},"CreateContactEmailsItems":{"type":"object","properties":{"email":{"type":"string","format":"email"},"type":{"type":"string"}},"required":["email"],"title":"CreateContactEmailsItems"},"CreateContactPhonesItems":{"type":"object","properties":{"phone":{"type":["string","null"],"description":"Phone number in E.164 format"},"type":{"type":"string"}},"title":"CreateContactPhonesItems"},"CreateContactUrlsItems":{"type":"object","properties":{"type":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["url"],"title":"CreateContactUrlsItems"},"CreateContact":{"type":"object","properties":{"created_by":{"type":["string","null"]},"date_created":{"type":["string","null"],"format":"date-time"},"emails":{"type":["array","null"],"items":{"$ref":"#/components/schemas/CreateContactEmailsItems"}},"lead_id":{"type":["string","null"]},"name":{"type":["string","null"],"maxLength":1000},"phones":{"type":["array","null"],"items":{"$ref":"#/components/schemas/CreateContactPhonesItems"}},"timezone":{"type":["string","null"],"description":"IANA timezone identifier"},"title":{"type":["string","null"],"maxLength":1000},"urls":{"type":["array","null"],"items":{"$ref":"#/components/schemas/CreateContactUrlsItems"}}},"title":"CreateContact"},"UpdateContactEmailsItems":{"type":"object","properties":{"email":{"type":"string","format":"email"},"type":{"type":"string"}},"required":["email"],"title":"UpdateContactEmailsItems"},"UpdateContactPhonesItems":{"type":"object","properties":{"phone":{"type":["string","null"],"description":"Phone number in E.164 format"},"type":{"type":"string"}},"title":"UpdateContactPhonesItems"},"UpdateContactUrlsItems":{"type":"object","properties":{"type":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["url"],"title":"UpdateContactUrlsItems"},"UpdateContact":{"type":"object","properties":{"emails":{"type":["array","null"],"items":{"$ref":"#/components/schemas/UpdateContactEmailsItems"}},"lead_id":{"type":["string","null"]},"name":{"type":["string","null"],"maxLength":1000},"phones":{"type":["array","null"],"items":{"$ref":"#/components/schemas/UpdateContactPhonesItems"}},"timezone":{"type":["string","null"],"description":"IANA timezone identifier"},"title":{"type":["string","null"],"maxLength":1000},"urls":{"type":["array","null"],"items":{"$ref":"#/components/schemas/UpdateContactUrlsItems"}}},"title":"UpdateContact"},"contacts_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"contacts_delete_Response_200"},"opportunities_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Opportunity"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"opportunities_list_Response_200"},"AttachmentIn":{"type":"object","properties":{"content_type":{"type":"string","default":""},"filename":{"type":"string"},"url":{"type":"string"}},"required":["filename","url"],"title":"AttachmentIn"},"CreateOpportunity":{"type":"object","properties":{"attachments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/AttachmentIn"},"default":null},"confidence":{"type":["integer","null"],"default":null},"contact_id":{"type":["string","null"],"default":null},"created_by":{"type":["string","null"],"default":null},"date_created":{"type":["string","null"],"format":"date-time","default":null},"date_won":{"type":["string","null"],"format":"date-time","default":null,"description":"If not set on the resource or in the request, `date_won` will be set automatically to today's date when setting `status_id` to a status with type `won`. The `x-tz-offset` header, used to pass your timezone's UTC offset, will be taken into account."},"lead_id":{"type":["string","null"],"default":null,"description":"Opportunities belong to exactly one Lead. If not provided, a new lead will be created (appearing as \"Untitled\" in the UI)."},"note":{"type":["string","null"],"default":null,"description":"Plaintext/markdown version of the note. If `note_html` is also provided in the same request, this value is ignored and `note` is derived from the HTML instead."},"note_html":{"type":["string","null"],"default":null,"description":"Rich-text HTML version of the note. When set, `note` is automatically populated with the plaintext version (tags become markdown), overriding any `note` value passed in the same request."},"pipeline_id":{"type":["string","null"],"default":null,"description":"Specify which pipeline this opportunity should belong to. When supplied without `status_id`, the opportunity will be created with the first available status of that pipeline. When supplied with `status_id`, the status must belong to the specified pipeline or a 400 error will be returned. If the pipeline does not exist, a 400 error will be returned. See the [Pipelines API](https://developer.close.com/api/resources/pipelines)."},"status_id":{"type":["string","null"],"default":null,"description":"Post a `status_id` to create an opportunity with a specific status. If omitted, the organization's default (first) status will be used (or the first status of the `pipeline_id` if provided). See the [Opportunity Status API](https://developer.close.com/api/resources/opportunity-statuses)."},"user_id":{"type":["string","null"],"default":null},"value":{"type":["integer","null"],"default":null},"value_period":{"oneOf":[{"$ref":"#/components/schemas/OpportunityValuePeriod"},{"type":"null"}],"default":null}},"title":"CreateOpportunity"},"UpdateOpportunity":{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentIn"}},"confidence":{"type":"integer"},"contact_id":{"type":["string","null"]},"date_won":{"type":["string","null"],"format":"date-time","description":"If not set on the resource or in the request, `date_won` will be set automatically to today's date when setting `status_id` to a status with type `won`. The `x-tz-offset` header, used to pass your timezone's UTC offset, will be taken into account."},"note":{"type":"string","description":"Plaintext/markdown version of the note. If `note_html` is also provided in the same request, this value is ignored and `note` is derived from the HTML instead."},"note_html":{"type":["string","null"],"description":"Rich-text HTML version of the note. When set, `note` is automatically populated with the plaintext version (tags become markdown), overriding any `note` value passed in the same request. Pass `null` to clear `note_html`; `note` is cleared as well."},"status":{"type":"string"},"status_id":{"type":"string","description":"Setting the `status_id` to a status with a type of `won` will automatically set the `date_won` field if it is not already set or provided in the request. Reverting it from a `won` status to an `active` or `lost` will not automatically change `date_won`."},"user_id":{"type":["string","null"]},"value":{"type":"integer"},"value_period":{"$ref":"#/components/schemas/OpportunityValuePeriod"}},"title":"UpdateOpportunity"},"opportunities_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"opportunities_delete_Response_200"},"tasks_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"tasks_list_Response_200"},"CreateTaskDiscriminatorMappingLeadDate":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"CreateTaskDiscriminatorMappingLeadDate"},"CreateTaskDiscriminatorMappingLeadDateCreated":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"CreateTaskDiscriminatorMappingLeadDateCreated"},"CreateTaskDiscriminatorMappingLeadDueDate":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"CreateTaskDiscriminatorMappingLeadDueDate"},"TaskPriority":{"type":"string","enum":["high","medium"],"title":"TaskPriority"},"CreateTaskDiscriminatorMappingOutgoingCallDate":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"CreateTaskDiscriminatorMappingOutgoingCallDate"},"CreateTask":{"oneOf":[{"type":"object","properties":{"_type":{"type":"string","enum":["lead"],"description":"Discriminator value: lead"},"assigned_to":{"type":["string","null"]},"contact_id":{"type":["string","null"]},"created_by":{"type":"string"},"date":{"$ref":"#/components/schemas/CreateTaskDiscriminatorMappingLeadDate"},"date_created":{"$ref":"#/components/schemas/CreateTaskDiscriminatorMappingLeadDateCreated"},"disable_notification":{"type":"boolean","default":false},"due_date":{"$ref":"#/components/schemas/CreateTaskDiscriminatorMappingLeadDueDate"},"is_complete":{"type":"boolean"},"is_dateless":{"type":"boolean"},"lead_id":{"type":"string"},"organization_id":{"type":"string"},"priority":{"$ref":"#/components/schemas/TaskPriority"},"text":{"type":"string"}},"required":["_type","lead_id","text"],"description":"CreateLeadTask variant"},{"type":"object","properties":{"_type":{"type":"string","enum":["outgoing_call"],"description":"Discriminator value: outgoing_call"},"agent_config_id":{"type":["string","null"]},"assigned_to":{"type":["string","null"]},"contact_id":{"type":"string"},"created_by":{"type":"string"},"date":{"$ref":"#/components/schemas/CreateTaskDiscriminatorMappingOutgoingCallDate"},"is_complete":{"type":"boolean"},"lead_id":{"type":"string"},"organization_id":{"type":"string"},"priority":{"$ref":"#/components/schemas/TaskPriority"},"text":{"type":["string","null"]}},"required":["_type","contact_id","lead_id"],"description":"CreateCallTask variant"}],"discriminator":{"propertyName":"_type"},"title":"CreateTask"},"tasks_create_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"tasks_create_Response_200"},"BulkUpdateNotificationsDate":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"BulkUpdateNotificationsDate"},"NotificationResolution":{"type":"string","enum":["abandoned","skipped"],"title":"NotificationResolution"},"BulkUpdateNotifications":{"type":"object","properties":{"assigned_to":{"type":"string"},"date":{"$ref":"#/components/schemas/BulkUpdateNotificationsDate"},"is_complete":{"type":"boolean"},"organization_id":{"type":"string"},"priority":{"$ref":"#/components/schemas/TaskPriority"},"resolution":{"oneOf":[{"$ref":"#/components/schemas/NotificationResolution"},{"type":"null"}]},"text":{"type":"string"}},"title":"BulkUpdateNotifications"},"tasks_bulkUpdate_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"tasks_bulkUpdate_Response_200"},"tasks_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"tasks_get_Response_200"},"UpdateNotificationDate":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"UpdateNotificationDate"},"UpdateNotificationDueDate":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"UpdateNotificationDueDate"},"UpdateNotification":{"type":"object","properties":{"agent_config_id":{"type":["string","null"]},"assigned_to":{"type":"string"},"contact_id":{"type":["string","null"]},"created_by":{"type":"string"},"date":{"$ref":"#/components/schemas/UpdateNotificationDate"},"due_date":{"$ref":"#/components/schemas/UpdateNotificationDueDate"},"is_complete":{"type":"boolean"},"is_dateless":{"type":"boolean"},"lead_id":{"type":"string"},"organization_id":{"type":"string"},"priority":{"$ref":"#/components/schemas/TaskPriority"},"resolution":{"oneOf":[{"$ref":"#/components/schemas/NotificationResolution"},{"type":"null"}]},"text":{"type":"string"}},"title":"UpdateNotification"},"tasks_update_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"tasks_update_Response_200"},"tasks_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"tasks_delete_Response_200"},"UploadFile":{"type":"object","properties":{"content_type":{"type":"string"},"filename":{"type":"string"}},"required":["content_type","filename"],"title":"UploadFile"},"files_create_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"files_create_Response_200"},"custom_objects_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_objects_list_Response_200"},"custom_objects_create_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"custom_objects_create_Response_201"},"custom_objects_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_objects_get_Response_200"},"custom_objects_update_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_objects_update_Response_200"},"comments_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"comments_list_Response_200"},"CreateComment":{"type":"object","properties":{"body":{"type":"string"},"object_id":{"type":"string"}},"required":["body","object_id"],"title":"CreateComment"},"comments_create_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"comments_create_Response_201"},"comments_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"comments_get_Response_200"},"UpdateCommentThreads":{"type":"object","properties":{"body":{"type":"string"}},"required":["body"],"title":"UpdateCommentThreads"},"comments_update_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"comments_update_Response_200"},"comments_listThreads_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"comments_listThreads_Response_200"},"comments_getThread_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"comments_getThread_Response_200"},"ActivityGetParametersDateCreatedGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityGetParametersDateCreatedGte"},"ActivityGetParametersDateCreatedLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityGetParametersDateCreatedLte"},"ActivityGetParametersDateCreatedGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityGetParametersDateCreatedGt"},"ActivityGetParametersDateCreatedLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityGetParametersDateCreatedLt"},"ActivityGetParametersActivityAtGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityGetParametersActivityAtGte"},"ActivityGetParametersActivityAtLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityGetParametersActivityAtLte"},"ActivityGetParametersActivityAtGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityGetParametersActivityAtGt"},"ActivityGetParametersActivityAtLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityGetParametersActivityAtLt"},"activities_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"activities_list_Response_200"},"ActivityNoteGetParametersDateCreatedGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityNoteGetParametersDateCreatedGte"},"ActivityNoteGetParametersDateCreatedLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityNoteGetParametersDateCreatedLte"},"ActivityNoteGetParametersDateCreatedGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityNoteGetParametersDateCreatedGt"},"ActivityNoteGetParametersDateCreatedLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityNoteGetParametersDateCreatedLt"},"ActivityNoteGetParametersActivityAtGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityNoteGetParametersActivityAtGte"},"ActivityNoteGetParametersActivityAtLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityNoteGetParametersActivityAtLte"},"ActivityNoteGetParametersActivityAtGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityNoteGetParametersActivityAtGt"},"ActivityNoteGetParametersActivityAtLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityNoteGetParametersActivityAtLt"},"CreationSource":{"type":"string","enum":["ui","api","import","clipper","email","suggestion","segment-integration","customerio-integration","calendly-integration","ai","whatsapp","webform"],"title":"CreationSource"},"ActivityBase":{"type":"object","properties":{"_type":{"type":"string"},"activity_at":{"type":["string","null"],"format":"date-time"},"agent_action_reason":{"type":["string","null"],"default":null},"agent_config_id":{"type":["string","null"],"default":null},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}},"comment_summary":{"oneOf":[{"$ref":"#/components/schemas/CommentSummary"},{"type":"null"}]},"contact_id":{"type":["string","null"]},"created_by":{"type":["string","null"]},"created_by_name":{"type":["string","null"],"default":null},"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"id":{"type":"string"},"lead_id":{"type":["string","null"]},"note":{"type":"string"},"note_html":{"type":"string"},"note_mentions":{"type":"array","items":{"type":"string"}},"organization_id":{"type":"string"},"pinned":{"type":"boolean"},"pinned_at":{"type":["string","null"],"format":"date-time"},"source":{"oneOf":[{"$ref":"#/components/schemas/CreationSource"},{"type":"null"}]},"title":{"type":["string","null"]},"updated_by":{"type":["string","null"]},"updated_by_name":{"type":["string","null"],"default":null},"user_id":{"type":["string","null"]},"user_name":{"type":["string","null"],"default":null},"users":{"type":"array","items":{"type":"string"}}},"required":["_type","activity_at","attachments","contact_id","created_by","date_created","date_updated","id","lead_id","note","note_html","note_mentions","organization_id","pinned","pinned_at","source","title","updated_by","user_id","users"],"title":"ActivityBase"},"activities.notes_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ActivityBase"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"activities.notes_list_Response_200"},"CreateNoteActivityAttachmentsItems":{"type":"object","properties":{"content_type":{"type":["string","null"]},"filename":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["filename","url"],"title":"CreateNoteActivityAttachmentsItems"},"CreateNoteActivity":{"type":"object","properties":{"activity_at":{"type":["string","null"],"format":"date-time"},"attachments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/CreateNoteActivityAttachmentsItems"}},"contact_id":{"type":["string","null"]},"created_by":{"type":["string","null"]},"date_created":{"type":["string","null"],"format":"date-time"},"lead_id":{"type":"string"},"note":{"type":["string","null"]},"note_html":{"type":["string","null"]},"organization_id":{"type":["string","null"]},"pinned":{"type":["boolean","null"]},"title":{"type":["string","null"]},"user_id":{"type":["string","null"]}},"required":["lead_id"],"title":"CreateNoteActivity"},"UpdateNoteActivityAttachmentsItems":{"type":"object","properties":{"content_type":{"type":["string","null"]},"filename":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["filename","url"],"title":"UpdateNoteActivityAttachmentsItems"},"UpdateNoteActivity":{"type":"object","properties":{"activity_at":{"type":["string","null"],"format":"date-time"},"attachments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/UpdateNoteActivityAttachmentsItems"}},"contact_id":{"type":["string","null"]},"note":{"type":["string","null"]},"note_html":{"type":["string","null"]},"pinned":{"type":["boolean","null"]},"title":{"type":["string","null"]}},"title":"UpdateNoteActivity"},"activities.notes_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"activities.notes_delete_Response_200"},"ActivityCallGetParametersDateCreatedGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCallGetParametersDateCreatedGte"},"ActivityCallGetParametersDateCreatedLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCallGetParametersDateCreatedLte"},"ActivityCallGetParametersDateCreatedGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCallGetParametersDateCreatedGt"},"ActivityCallGetParametersDateCreatedLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCallGetParametersDateCreatedLt"},"ActivityCallGetParametersActivityAtGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCallGetParametersActivityAtGte"},"ActivityCallGetParametersActivityAtLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCallGetParametersActivityAtLte"},"ActivityCallGetParametersActivityAtGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCallGetParametersActivityAtGt"},"ActivityCallGetParametersActivityAtLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCallGetParametersActivityAtLt"},"PhoneActivitySource":{"type":"string","enum":["Close.io","External"],"description":"Source of a phone activity. Describes whether the phone activity (such as a call or an SMS) was handled by Close's telephony provider or handled externally by a 3rd party and is merely logged in Close.","title":"PhoneActivitySource"},"CallActivity":{"type":"object","properties":{"_type":{"type":"string"},"activity_at":{"type":["string","null"],"format":"date-time"},"contact_id":{"type":["string","null"]},"created_by":{"type":["string","null"]},"created_by_name":{"type":["string","null"],"default":null},"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"id":{"type":"string"},"lead_id":{"type":["string","null"]},"organization_id":{"type":"string"},"outcome_id":{"type":["string","null"]},"sequence_id":{"type":["string","null"],"default":null},"sequence_name":{"type":["string","null"],"default":null},"sequence_subscription_id":{"type":["string","null"],"default":null},"source":{"$ref":"#/components/schemas/PhoneActivitySource"},"status":{"$ref":"#/components/schemas/CallStatus"},"updated_by":{"type":["string","null"]},"updated_by_name":{"type":["string","null"],"default":null},"user_id":{"type":["string","null"]},"user_name":{"type":["string","null"],"default":null},"users":{"type":"array","items":{"type":"string"}}},"required":["_type","activity_at","contact_id","created_by","date_created","date_updated","id","lead_id","organization_id","outcome_id","source","status","updated_by","user_id","users"],"title":"CallActivity"},"activities.calls_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CallActivity"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"activities.calls_list_Response_200"},"CreateCallActivityDirection":{"type":"string","enum":["inbound","outbound"],"title":"CreateCallActivityDirection"},"CreateCallActivitySource":{"type":"string","enum":["Close.io","External"],"title":"CreateCallActivitySource"},"CreateCallActivityStatus":{"type":"string","enum":["created","in-progress","completed","cancel","no-answer","busy","failed","timeout"],"title":"CreateCallActivityStatus"},"CreateCallActivity":{"type":"object","properties":{"activity_at":{"type":["string","null"],"format":"date-time"},"contact_id":{"type":["string","null"]},"conversation_type_id":{"type":["string","null"]},"created_by":{"type":["string","null"]},"date_created":{"type":["string","null"],"format":"date-time"},"direction":{"$ref":"#/components/schemas/CreateCallActivityDirection"},"duration":{"type":["integer","null"],"maximum":604800},"lead_id":{"type":["string","null"]},"note":{"type":["string","null"]},"note_html":{"type":["string","null"]},"organization_id":{"type":["string","null"]},"outcome_id":{"type":["string","null"]},"phone":{"type":["string","null"],"description":"Phone number in E.164 format"},"playbook_id":{"type":["string","null"]},"quality_info":{"type":["string","null"]},"recording_url":{"type":["string","null"],"format":"uri"},"source":{"$ref":"#/components/schemas/CreateCallActivitySource"},"status":{"$ref":"#/components/schemas/CreateCallActivityStatus"},"user_id":{"type":["string","null"]},"voicemail_url":{"type":["string","null"],"format":"uri"}},"title":"CreateCallActivity"},"UpdateCallActivityStatus":{"type":"string","enum":["created","in-progress","completed","cancel","no-answer","busy","failed","timeout"],"title":"UpdateCallActivityStatus"},"UpdateCallActivity":{"type":"object","properties":{"activity_at":{"type":["string","null"],"format":"date-time"},"contact_id":{"type":["string","null"]},"conversation_type_id":{"type":["string","null"]},"duration":{"type":["integer","null"],"maximum":604800},"lead_id":{"type":["string","null"]},"note":{"type":["string","null"]},"note_html":{"type":["string","null"]},"outcome_id":{"type":["string","null"]},"phone":{"type":["string","null"],"description":"Phone number in E.164 format"},"playbook_id":{"type":["string","null"]},"quality_info":{"type":["string","null"]},"recording_url":{"type":["string","null"],"format":"uri"},"status":{"$ref":"#/components/schemas/UpdateCallActivityStatus"},"user_id":{"type":["string","null"]},"voicemail_url":{"type":["string","null"],"format":"uri"}},"title":"UpdateCallActivity"},"activities.calls_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"activities.calls_delete_Response_200"},"ActivityEmailGetParametersDateCreatedGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityEmailGetParametersDateCreatedGte"},"ActivityEmailGetParametersDateCreatedLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityEmailGetParametersDateCreatedLte"},"ActivityEmailGetParametersDateCreatedGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityEmailGetParametersDateCreatedGt"},"ActivityEmailGetParametersDateCreatedLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityEmailGetParametersDateCreatedLt"},"ActivityEmailGetParametersActivityAtGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityEmailGetParametersActivityAtGte"},"ActivityEmailGetParametersActivityAtLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityEmailGetParametersActivityAtLte"},"ActivityEmailGetParametersActivityAtGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityEmailGetParametersActivityAtGt"},"ActivityEmailGetParametersActivityAtLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityEmailGetParametersActivityAtLt"},"CommunicationDirection":{"type":"string","enum":["incoming","outgoing"],"description":"Direction of communication. Outgoing means the communication flowing from the user to the lead/contact. Inbound means the opposite.","title":"CommunicationDirection"},"EmailOpen":{"type":"object","properties":{"ip_address":{"type":["string","null"]},"opened_at":{"type":"string","format":"date-time"},"opened_by":{"type":["string","null"]},"user_agent":{"type":["string","null"]}},"required":["ip_address","opened_at","opened_by","user_agent"],"title":"EmailOpen"},"MessageStatus":{"type":"string","enum":["inbox","draft","scheduled","outbox","sent","error"],"description":"Status of a message, such as Email or SMS.","title":"MessageStatus"},"EmailActivity":{"type":"object","properties":{"_type":{"type":"string"},"activity_at":{"type":["string","null"],"format":"date-time"},"agent_action_reason":{"type":["string","null"],"default":null},"agent_config_id":{"type":["string","null"],"default":null},"attachments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Attachment"},"default":null},"bcc":{"type":"array","items":{"type":"string"}},"body_html":{"type":["string","null"]},"body_preview":{"type":["string","null"],"default":null},"body_text":{"type":["string","null"]},"bulk_email_action_id":{"type":["string","null"]},"cc":{"type":"array","items":{"type":"string"}},"contact_id":{"type":["string","null"]},"created_by":{"type":["string","null"]},"created_by_name":{"type":["string","null"],"default":null},"date_created":{"type":"string","format":"date-time"},"date_scheduled":{"type":["string","null"],"format":"date-time"},"date_sent":{"type":["string","null"],"format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"direction":{"oneOf":[{"$ref":"#/components/schemas/CommunicationDirection"},{"type":"null"}]},"email_account_id":{"type":["string","null"],"default":null},"envelope":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"default":null},"followup_sequence_add_cc_bcc":{"type":"boolean"},"followup_sequence_delay":{"type":["integer","null"]},"followup_sequence_id":{"type":["string","null"],"default":null},"has_reply":{"type":"boolean"},"id":{"type":"string"},"in_reply_to_id":{"type":["string","null"]},"lead_id":{"type":["string","null"]},"message_ids":{"type":"array","items":{"type":"string"}},"need_smtp_credentials":{"type":"boolean"},"opens":{"type":["array","null"],"items":{"$ref":"#/components/schemas/EmailOpen"},"default":null},"opens_summary":{"type":["string","null"]},"organization_id":{"type":"string"},"references":{"type":"array","items":{"type":"string"}},"send_as_id":{"type":["string","null"]},"send_attempts":{"type":["array","null"],"items":{"type":"object","additionalProperties":{"type":"string"}},"default":null},"sender":{"type":["string","null"]},"sequence_id":{"type":["string","null"],"default":null},"sequence_name":{"type":["string","null"],"default":null},"sequence_subscription_id":{"type":["string","null"],"default":null},"status":{"$ref":"#/components/schemas/MessageStatus"},"subject":{"type":["string","null"]},"template_id":{"type":["string","null"]},"template_name":{"type":["string","null"],"default":null},"thread_id":{"type":["string","null"]},"to":{"type":"array","items":{"type":"string"}},"updated_by":{"type":["string","null"]},"updated_by_name":{"type":["string","null"],"default":null},"user_id":{"type":["string","null"]},"user_name":{"type":["string","null"],"default":null},"users":{"type":"array","items":{"type":"string"}}},"required":["_type","activity_at","bcc","body_html","body_text","bulk_email_action_id","cc","contact_id","created_by","date_created","date_scheduled","date_sent","date_updated","direction","followup_sequence_add_cc_bcc","followup_sequence_delay","has_reply","id","in_reply_to_id","lead_id","message_ids","need_smtp_credentials","opens_summary","organization_id","references","send_as_id","sender","status","subject","template_id","thread_id","to","updated_by","user_id","users"],"title":"EmailActivity"},"activities.emails_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EmailActivity"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"activities.emails_list_Response_200"},"CreateEmailActivityAttachmentsItems":{"type":"object","properties":{"content_id":{"type":["string","null"]},"content_type":{"type":["string","null"]},"filename":{"type":"string"},"inline_only":{"type":"boolean"},"size":{"type":"integer"},"url":{"type":"string","format":"uri"}},"required":["filename","size","url"],"title":"CreateEmailActivityAttachmentsItems"},"CreateEmailActivityOpensItems":{"type":"object","properties":{"opened_at":{"type":"string","format":"date-time"}},"required":["opened_at"],"title":"CreateEmailActivityOpensItems"},"CreateEmailActivityStatus":{"type":"string","enum":["inbox","draft","scheduled","outbox","sent","error"],"title":"CreateEmailActivityStatus"},"CreateEmailActivity":{"type":"object","properties":{"activity_at":{"type":["string","null"],"format":"date-time"},"attachments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/CreateEmailActivityAttachmentsItems"}},"bcc":{"type":["array","null"],"items":{"type":"string","maxLength":1000}},"body_html":{"type":["string","null"],"maxLength":1048576},"body_text":{"type":["string","null"],"maxLength":1048576},"cc":{"type":["array","null"],"items":{"type":"string","maxLength":1000}},"contact_id":{"type":["string","null"]},"created_by":{"type":["string","null"]},"date_created":{"type":["string","null"],"format":"date-time"},"email_account_id":{"type":["string","null"]},"followup_date":{"type":["string","null"],"format":"date-time"},"followup_sequence_add_cc_bcc":{"type":["boolean","null"]},"followup_sequence_delay":{"type":["integer","null"],"minimum":86400},"followup_sequence_id":{"type":["string","null"]},"in_reply_to_id":{"type":["string","null"]},"lead_id":{"type":"string"},"opens":{"type":["array","null"],"items":{"$ref":"#/components/schemas/CreateEmailActivityOpensItems"}},"organization_id":{"type":["string","null"]},"sender":{"type":["string","null"],"format":"email"},"status":{"$ref":"#/components/schemas/CreateEmailActivityStatus"},"subject":{"type":["string","null"],"maxLength":1000},"template_id":{"type":["string","null"]},"to":{"type":["array","null"],"items":{"type":"string","maxLength":1000}},"user_id":{"type":["string","null"]}},"required":["lead_id","status"],"title":"CreateEmailActivity"},"UpdateEmailActivityAttachmentsItems":{"type":"object","properties":{"content_id":{"type":["string","null"]},"content_type":{"type":["string","null"]},"filename":{"type":"string"},"inline_only":{"type":"boolean"},"size":{"type":"integer"},"url":{"type":"string","format":"uri"}},"required":["filename","size","url"],"title":"UpdateEmailActivityAttachmentsItems"},"UpdateEmailActivityOpensItems":{"type":"object","properties":{"opened_at":{"type":"string","format":"date-time"}},"required":["opened_at"],"title":"UpdateEmailActivityOpensItems"},"UpdateEmailActivityStatus":{"type":"string","enum":["inbox","draft","scheduled","outbox","sent","error"],"title":"UpdateEmailActivityStatus"},"UpdateEmailActivity":{"type":"object","properties":{"activity_at":{"type":["string","null"],"format":"date-time"},"attachments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/UpdateEmailActivityAttachmentsItems"}},"bcc":{"type":["array","null"],"items":{"type":"string","maxLength":1000}},"body_html":{"type":["string","null"],"maxLength":1048576},"body_text":{"type":["string","null"],"maxLength":1048576},"cc":{"type":["array","null"],"items":{"type":"string","maxLength":1000}},"contact_id":{"type":["string","null"]},"email_account_id":{"type":["string","null"]},"followup_date":{"type":["string","null"],"format":"date-time"},"followup_sequence_add_cc_bcc":{"type":["boolean","null"]},"followup_sequence_delay":{"type":["integer","null"],"minimum":86400},"followup_sequence_id":{"type":["string","null"]},"in_reply_to_id":{"type":["string","null"]},"opens":{"type":["array","null"],"items":{"$ref":"#/components/schemas/UpdateEmailActivityOpensItems"}},"sender":{"type":["string","null"],"format":"email"},"status":{"$ref":"#/components/schemas/UpdateEmailActivityStatus"},"subject":{"type":["string","null"],"maxLength":1000},"template_id":{"type":["string","null"]},"to":{"type":["array","null"],"items":{"type":"string","maxLength":1000}},"user_id":{"type":["string","null"]}},"title":"UpdateEmailActivity"},"activities.emails_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"activities.emails_delete_Response_200"},"ActivityEmailthreadGetParametersDateCreatedGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityEmailthreadGetParametersDateCreatedGte"},"ActivityEmailthreadGetParametersDateCreatedLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityEmailthreadGetParametersDateCreatedLte"},"ActivityEmailthreadGetParametersDateCreatedGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityEmailthreadGetParametersDateCreatedGt"},"ActivityEmailthreadGetParametersDateCreatedLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityEmailthreadGetParametersDateCreatedLt"},"ActivityEmailthreadGetParametersActivityAtGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityEmailthreadGetParametersActivityAtGte"},"ActivityEmailthreadGetParametersActivityAtLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityEmailthreadGetParametersActivityAtLte"},"ActivityEmailthreadGetParametersActivityAtGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityEmailthreadGetParametersActivityAtGt"},"ActivityEmailthreadGetParametersActivityAtLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityEmailthreadGetParametersActivityAtLt"},"QuotedEmailHTML":{"type":"object","properties":{"expand":{"type":"boolean"},"html":{"type":"string"}},"required":["expand","html"],"title":"QuotedEmailHTML"},"QuotedEmailText":{"type":"object","properties":{"expand":{"type":"boolean"},"text":{"type":"string"}},"required":["expand","text"],"title":"QuotedEmailText"},"EmailInThread":{"type":"object","properties":{"_type":{"type":"string"},"activity_at":{"type":["string","null"],"format":"date-time"},"agent_action_reason":{"type":["string","null"],"default":null},"agent_config_id":{"type":["string","null"],"default":null},"ai_draft":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"attachments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Attachment"},"default":null},"bcc":{"type":"array","items":{"type":"string"}},"body_html":{"type":["string","null"]},"body_html_quoted":{"type":["array","null"],"items":{"$ref":"#/components/schemas/QuotedEmailHTML"}},"body_preview":{"type":["string","null"],"default":null},"body_text":{"type":["string","null"]},"body_text_quoted":{"type":["array","null"],"items":{"$ref":"#/components/schemas/QuotedEmailText"}},"bulk_email_action_id":{"type":["string","null"]},"cc":{"type":"array","items":{"type":"string"}},"contact_id":{"type":["string","null"]},"created_by":{"type":["string","null"]},"created_by_name":{"type":["string","null"],"default":null},"date_created":{"type":"string","format":"date-time"},"date_scheduled":{"type":["string","null"],"format":"date-time"},"date_sent":{"type":["string","null"],"format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"direction":{"oneOf":[{"$ref":"#/components/schemas/CommunicationDirection"},{"type":"null"}]},"email_account_id":{"type":["string","null"],"default":null},"envelope":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"default":null},"followup_sequence_add_cc_bcc":{"type":"boolean"},"followup_sequence_delay":{"type":["integer","null"]},"followup_sequence_id":{"type":["string","null"],"default":null},"has_reply":{"type":"boolean"},"id":{"type":"string"},"in_reply_to_id":{"type":["string","null"]},"lead_id":{"type":["string","null"]},"message_ids":{"type":"array","items":{"type":"string"}},"need_smtp_credentials":{"type":"boolean"},"opens":{"type":["array","null"],"items":{"$ref":"#/components/schemas/EmailOpen"},"default":null},"opens_summary":{"type":["string","null"]},"organization_id":{"type":"string"},"references":{"type":"array","items":{"type":"string"}},"send_as_id":{"type":["string","null"]},"send_attempts":{"type":["array","null"],"items":{"type":"object","additionalProperties":{"type":"string"}},"default":null},"sender":{"type":["string","null"]},"sequence_id":{"type":["string","null"],"default":null},"sequence_name":{"type":["string","null"],"default":null},"sequence_subscription_id":{"type":["string","null"],"default":null},"status":{"$ref":"#/components/schemas/MessageStatus"},"subject":{"type":["string","null"]},"template_id":{"type":["string","null"]},"template_name":{"type":["string","null"],"default":null},"thread_id":{"type":["string","null"]},"to":{"type":"array","items":{"type":"string"}},"updated_by":{"type":["string","null"]},"updated_by_name":{"type":["string","null"],"default":null},"user_id":{"type":["string","null"]},"user_name":{"type":["string","null"],"default":null},"users":{"type":"array","items":{"type":"string"}}},"required":["_type","activity_at","bcc","bulk_email_action_id","cc","contact_id","created_by","date_created","date_scheduled","date_sent","date_updated","direction","followup_sequence_add_cc_bcc","followup_sequence_delay","has_reply","id","in_reply_to_id","lead_id","message_ids","need_smtp_credentials","opens_summary","organization_id","references","send_as_id","sender","status","subject","template_id","thread_id","to","updated_by","user_id","users"],"title":"EmailInThread"},"ImportantThreadReason":{"type":"string","enum":["manual","contains-manual-message","most-recent-communication","has-response","whitelisted","by-default","unset-initial-default"],"title":"ImportantThreadReason"},"ImportantEmailThread":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/ImportantThreadReason"},"type":{"type":"string","enum":["important"]}},"required":["reason","type"],"title":"ImportantEmailThread"},"NotImportantThreadReason":{"type":"string","enum":["manual","scheduling-emails","automated-outbound","marketing-or-transactional","by-default"],"title":"NotImportantThreadReason"},"NotImportantEmailThread":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/NotImportantThreadReason"},"type":{"type":"string","enum":["not_important"]}},"required":["reason","type"],"title":"NotImportantEmailThread"},"EmailThreadActivityImportance":{"oneOf":[{"$ref":"#/components/schemas/ImportantEmailThread"},{"$ref":"#/components/schemas/NotImportantEmailThread"}],"title":"EmailThreadActivityImportance"},"EmailIdentity":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"}},"required":["email","name"],"title":"EmailIdentity"},"EmailEnvelope":{"type":"object","properties":{"bcc":{"type":"array","items":{"$ref":"#/components/schemas/EmailIdentity"}},"cc":{"type":"array","items":{"$ref":"#/components/schemas/EmailIdentity"}},"date":{"type":["string","null"]},"from":{"type":"array","items":{"$ref":"#/components/schemas/EmailIdentity"}},"in_reply_to":{"type":["string","null"]},"is_autoreply":{"type":"boolean"},"message_id":{"type":["string","null"]},"reply_to":{"type":"array","items":{"$ref":"#/components/schemas/EmailIdentity"}},"sender":{"type":"array","items":{"$ref":"#/components/schemas/EmailIdentity"}},"subject":{"type":["string","null"]},"to":{"type":"array","items":{"$ref":"#/components/schemas/EmailIdentity"}}},"required":["bcc","cc","date","from","in_reply_to","is_autoreply","message_id","reply_to","sender","subject","to"],"title":"EmailEnvelope"},"EmailPreview":{"type":"object","properties":{"bcc":{"type":"array","items":{"type":"string"}},"body_preview":{"type":["string","null"]},"cc":{"type":"array","items":{"type":"string"}},"date_created":{"type":"string","format":"date-time"},"date_sent":{"type":["string","null"],"format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"direction":{"$ref":"#/components/schemas/CommunicationDirection"},"envelope":{"oneOf":[{"$ref":"#/components/schemas/EmailEnvelope"},{"type":"null"}]},"has_attachments":{"type":["boolean","null"]},"id":{"type":["string","null"]},"opens_summary":{"type":["string","null"]},"send_as_id":{"type":["string","null"]},"sender":{"type":["string","null"]},"status":{"$ref":"#/components/schemas/MessageStatus"},"subject":{"type":["string","null"]},"to":{"type":"array","items":{"type":"string"}},"user_id":{"type":["string","null"]}},"required":["bcc","body_preview","cc","date_created","date_sent","date_updated","direction","envelope","has_attachments","id","opens_summary","send_as_id","sender","status","subject","to","user_id"],"title":"EmailPreview"},"SummaryFeedbackRating":{"type":"string","enum":["positive","negative"],"title":"SummaryFeedbackRating"},"EmailThreadSummaryFeedback":{"type":"object","properties":{"detail":{"type":["string","null"]},"given_at":{"type":"string","format":"date-time"},"rating":{"$ref":"#/components/schemas/SummaryFeedbackRating"}},"required":["detail","given_at","rating"],"title":"EmailThreadSummaryFeedback"},"SummaryStatus":{"type":"string","enum":["pending","success","failure","expired"],"title":"SummaryStatus"},"EmailThreadSummary":{"type":"object","properties":{"expired_at":{"type":["string","null"],"format":"date-time"},"feedback":{"$ref":"#/components/schemas/EmailThreadSummaryFeedback"},"generated_at":{"type":["string","null"],"format":"date-time"},"status":{"$ref":"#/components/schemas/SummaryStatus"},"summary_html":{"type":["string","null"]},"summary_text":{"type":["string","null"]},"updated_at":{"type":"string","format":"date-time"}},"required":["expired_at","generated_at","status","summary_html","summary_text","updated_at"],"title":"EmailThreadSummary"},"EmailThreadActivity":{"type":"object","properties":{"_type":{"type":"string"},"activity_at":{"type":["string","null"],"format":"date-time"},"comment_summary":{"oneOf":[{"$ref":"#/components/schemas/CommentSummary"},{"type":"null"}]},"contact_id":{"type":["string","null"]},"created_by":{"type":["string","null"]},"created_by_name":{"type":["string","null"],"default":null},"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailInThread"}},"id":{"type":"string"},"importance":{"$ref":"#/components/schemas/EmailThreadActivityImportance"},"latest_emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailPreview"}},"latest_normalized_subject":{"type":["string","null"]},"lead_id":{"type":["string","null"]},"n_emails":{"type":["integer","null"]},"organization_id":{"type":"string"},"participants":{"type":"array","items":{"$ref":"#/components/schemas/EmailIdentity"}},"summary":{"oneOf":[{"$ref":"#/components/schemas/EmailThreadSummary"},{"type":"null"}]},"updated_by":{"type":["string","null"]},"updated_by_name":{"type":["string","null"],"default":null},"user_id":{"type":["string","null"]},"user_name":{"type":["string","null"],"default":null},"users":{"type":"array","items":{"type":"string"}}},"required":["_type","activity_at","contact_id","created_by","date_created","date_updated","id","latest_normalized_subject","lead_id","n_emails","organization_id","updated_by","user_id","users"],"title":"EmailThreadActivity"},"activities.email_threads_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EmailThreadActivity"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"activities.email_threads_list_Response_200"},"activities.email_threads_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"activities.email_threads_delete_Response_200"},"ActivitySmsGetParametersDateCreatedGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivitySmsGetParametersDateCreatedGte"},"ActivitySmsGetParametersDateCreatedLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivitySmsGetParametersDateCreatedLte"},"ActivitySmsGetParametersDateCreatedGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivitySmsGetParametersDateCreatedGt"},"ActivitySmsGetParametersDateCreatedLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivitySmsGetParametersDateCreatedLt"},"ActivitySmsGetParametersActivityAtGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivitySmsGetParametersActivityAtGte"},"ActivitySmsGetParametersActivityAtLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivitySmsGetParametersActivityAtLte"},"ActivitySmsGetParametersActivityAtGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivitySmsGetParametersActivityAtGt"},"ActivitySmsGetParametersActivityAtLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivitySmsGetParametersActivityAtLt"},"CallerIdMode":{"type":"string","enum":["fixed","auto"],"description":"How a caller's outbound number is chosen. Fixed uses a single configured number; Auto lets Close select the best number per call/SMS (Managed by Close Caller ID).","title":"CallerIdMode"},"CallerIdReason":{"type":"string","enum":["context","local_presence","fallback"],"description":"Why a number was chosen in Auto mode: reused from a prior communication (context), picked for geographic proximity (local_presence), or the default/oldest fallback.","title":"CallerIdReason"},"PhoneActivityDirection":{"type":"string","enum":["inbound","outbound"],"description":"Direction of a phone activity, such as a call or an SMS message.","title":"PhoneActivityDirection"},"SMSActivity":{"type":"object","properties":{"_type":{"type":"string"},"activity_at":{"type":["string","null"],"format":"date-time"},"agent_action_reason":{"type":["string","null"],"default":null},"agent_config_id":{"type":["string","null"],"default":null},"caller_id_mode":{"oneOf":[{"$ref":"#/components/schemas/CallerIdMode"},{"type":"null"}]},"caller_id_reason":{"oneOf":[{"$ref":"#/components/schemas/CallerIdReason"},{"type":"null"}]},"contact_id":{"type":["string","null"]},"cost":{"type":["string","null"]},"created_by":{"type":["string","null"]},"created_by_name":{"type":["string","null"],"default":null},"date_created":{"type":"string","format":"date-time"},"date_scheduled":{"type":["string","null"],"format":"date-time"},"date_sent":{"type":["string","null"],"format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"direction":{"$ref":"#/components/schemas/PhoneActivityDirection"},"error_message":{"type":["string","null"]},"id":{"type":"string"},"lead_id":{"type":["string","null"]},"local_country_iso":{"type":["string","null"]},"local_phone":{"type":["string","null"]},"local_phone_formatted":{"type":["string","null"]},"organization_id":{"type":"string"},"remote_country_iso":{"type":["string","null"]},"remote_phone":{"type":["string","null"]},"remote_phone_formatted":{"type":["string","null"]},"sequence_id":{"type":["string","null"],"default":null},"sequence_name":{"type":["string","null"],"default":null},"sequence_subscription_id":{"type":["string","null"],"default":null},"source":{"$ref":"#/components/schemas/PhoneActivitySource"},"status":{"$ref":"#/components/schemas/MessageStatus"},"template_id":{"type":["string","null"]},"text":{"type":["string","null"]},"updated_by":{"type":["string","null"]},"updated_by_name":{"type":["string","null"],"default":null},"user_id":{"type":["string","null"]},"user_name":{"type":["string","null"],"default":null},"users":{"type":"array","items":{"type":"string"}}},"required":["_type","activity_at","caller_id_mode","caller_id_reason","contact_id","cost","created_by","date_created","date_scheduled","date_sent","date_updated","direction","error_message","id","lead_id","local_country_iso","local_phone","local_phone_formatted","organization_id","remote_country_iso","remote_phone","remote_phone_formatted","source","status","template_id","text","updated_by","user_id","users"],"title":"SMSActivity"},"activities.sms_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SMSActivity"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"activities.sms_list_Response_200"},"CreateSmsActivityAttachmentsItemsContentType":{"type":"string","enum":["application/pdf","application/vcard","audio/3gpp","audio/3gpp2","audio/L24","audio/ac3","audio/amr","audio/amr-nb","audio/basic","audio/mp4","audio/mpeg","audio/ogg","audio/vnd.rn-realaudio","audio/vnd.wave","audio/webm","image/bmp","image/gif","image/jpeg","image/jpg","image/png","image/tiff","text/calendar","text/csv","text/directory","text/richtext","text/rtf","text/vcard","text/x-vcard","video/3gpp","video/3gpp-tt","video/3gpp2","video/H261","video/H263","video/H263-1998","video/H263-2000","video/H264","video/mp4","video/mpeg","video/quicktime","video/webm"],"title":"CreateSmsActivityAttachmentsItemsContentType"},"CreateSmsActivityAttachmentsItems":{"type":"object","properties":{"content_type":{"$ref":"#/components/schemas/CreateSmsActivityAttachmentsItemsContentType"},"filename":{"type":"string"},"url":{"type":"string"}},"required":["content_type","filename","url"],"title":"CreateSmsActivityAttachmentsItems"},"CreateSmsActivityCallerIdMode":{"type":"string","enum":["fixed","auto"],"title":"CreateSmsActivityCallerIdMode"},"CreateSmsActivityDirection":{"type":"string","enum":["inbound","outbound"],"title":"CreateSmsActivityDirection"},"CreateSmsActivitySource":{"type":"string","enum":["Close.io","External"],"title":"CreateSmsActivitySource"},"CreateSmsActivityStatus":{"type":"string","enum":["inbox","draft","scheduled","outbox","sent","error"],"title":"CreateSmsActivityStatus"},"CreateSMSActivity":{"type":"object","properties":{"activity_at":{"type":["string","null"],"format":"date-time"},"attachments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/CreateSmsActivityAttachmentsItems"}},"caller_id_mode":{"$ref":"#/components/schemas/CreateSmsActivityCallerIdMode"},"contact_id":{"type":["string","null"]},"created_by":{"type":["string","null"]},"date_created":{"type":["string","null"],"format":"date-time"},"direction":{"$ref":"#/components/schemas/CreateSmsActivityDirection"},"lead_id":{"type":["string","null"]},"local_phone":{"type":["string","null"],"description":"Phone number in E.164 format"},"organization_id":{"type":["string","null"]},"remote_phone":{"type":["string","null"],"description":"Phone number in E.164 format"},"source":{"$ref":"#/components/schemas/CreateSmsActivitySource"},"status":{"$ref":"#/components/schemas/CreateSmsActivityStatus"},"template_id":{"type":["string","null"]},"text":{"type":["string","null"]},"user_id":{"type":["string","null"]}},"required":["status"],"title":"CreateSMSActivity"},"UpdateSmsActivityAttachmentsItemsContentType":{"type":"string","enum":["application/pdf","application/vcard","audio/3gpp","audio/3gpp2","audio/L24","audio/ac3","audio/amr","audio/amr-nb","audio/basic","audio/mp4","audio/mpeg","audio/ogg","audio/vnd.rn-realaudio","audio/vnd.wave","audio/webm","image/bmp","image/gif","image/jpeg","image/jpg","image/png","image/tiff","text/calendar","text/csv","text/directory","text/richtext","text/rtf","text/vcard","text/x-vcard","video/3gpp","video/3gpp-tt","video/3gpp2","video/H261","video/H263","video/H263-1998","video/H263-2000","video/H264","video/mp4","video/mpeg","video/quicktime","video/webm"],"title":"UpdateSmsActivityAttachmentsItemsContentType"},"UpdateSmsActivityAttachmentsItems":{"type":"object","properties":{"content_type":{"$ref":"#/components/schemas/UpdateSmsActivityAttachmentsItemsContentType"},"filename":{"type":"string"},"url":{"type":"string"}},"required":["content_type","filename","url"],"title":"UpdateSmsActivityAttachmentsItems"},"UpdateSmsActivityCallerIdMode":{"type":"string","enum":["fixed","auto"],"title":"UpdateSmsActivityCallerIdMode"},"UpdateSmsActivityStatus":{"type":"string","enum":["inbox","draft","scheduled","outbox","sent","error"],"title":"UpdateSmsActivityStatus"},"UpdateSMSActivity":{"type":"object","properties":{"activity_at":{"type":["string","null"],"format":"date-time"},"attachments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/UpdateSmsActivityAttachmentsItems"}},"caller_id_mode":{"$ref":"#/components/schemas/UpdateSmsActivityCallerIdMode"},"contact_id":{"type":["string","null"]},"lead_id":{"type":["string","null"]},"local_phone":{"type":["string","null"],"description":"Phone number in E.164 format"},"remote_phone":{"type":["string","null"],"description":"Phone number in E.164 format"},"status":{"$ref":"#/components/schemas/UpdateSmsActivityStatus"},"template_id":{"type":["string","null"]},"text":{"type":["string","null"]},"user_id":{"type":["string","null"]}},"title":"UpdateSMSActivity"},"activities.sms_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"activities.sms_delete_Response_200"},"ActivityWhatsappMessageGetParametersDateCreatedGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityWhatsappMessageGetParametersDateCreatedGte"},"ActivityWhatsappMessageGetParametersDateCreatedLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityWhatsappMessageGetParametersDateCreatedLte"},"ActivityWhatsappMessageGetParametersDateCreatedGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityWhatsappMessageGetParametersDateCreatedGt"},"ActivityWhatsappMessageGetParametersDateCreatedLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityWhatsappMessageGetParametersDateCreatedLt"},"ActivityWhatsappMessageGetParametersActivityAtGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityWhatsappMessageGetParametersActivityAtGte"},"ActivityWhatsappMessageGetParametersActivityAtLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityWhatsappMessageGetParametersActivityAtLte"},"ActivityWhatsappMessageGetParametersActivityAtGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityWhatsappMessageGetParametersActivityAtGt"},"ActivityWhatsappMessageGetParametersActivityAtLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityWhatsappMessageGetParametersActivityAtLt"},"WhatsAppMessageActivity":{"type":"object","properties":{"_type":{"type":"string"},"activity_at":{"type":["string","null"],"format":"date-time"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}},"contact_id":{"type":["string","null"]},"created_by":{"type":["string","null"]},"created_by_name":{"type":["string","null"],"default":null},"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"direction":{"$ref":"#/components/schemas/CommunicationDirection"},"external_whatsapp_message_id":{"type":"string"},"id":{"type":"string"},"integration_link":{"type":["string","null"]},"integration_name":{"type":["string","null"]},"lead_id":{"type":["string","null"]},"local_phone":{"type":"string"},"local_phone_formatted":{"type":"string"},"message_html":{"type":"string"},"message_markdown":{"type":"string"},"organization_id":{"type":"string"},"remote_phone":{"type":"string"},"remote_phone_formatted":{"type":"string"},"response_to_id":{"type":["string","null"]},"sequence_id":{"type":["string","null"],"default":null},"sequence_name":{"type":["string","null"],"default":null},"sequence_subscription_id":{"type":["string","null"],"default":null},"source":{"$ref":"#/components/schemas/CreationSource"},"text":{"type":"string"},"updated_by":{"type":["string","null"]},"updated_by_name":{"type":["string","null"],"default":null},"user_id":{"type":["string","null"]},"user_name":{"type":["string","null"],"default":null},"users":{"type":"array","items":{"type":"string"}}},"required":["_type","activity_at","contact_id","created_by","date_created","date_updated","direction","external_whatsapp_message_id","id","integration_link","integration_name","lead_id","local_phone","local_phone_formatted","message_html","message_markdown","organization_id","remote_phone","remote_phone_formatted","response_to_id","source","text","updated_by","user_id","users"],"title":"WhatsAppMessageActivity"},"activities.whatsapp_messages_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WhatsAppMessageActivity"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"activities.whatsapp_messages_list_Response_200"},"WhatsAppAttachmentData":{"type":"object","properties":{"content_type":{"type":"string"},"filename":{"type":"string"},"url":{"type":"string"}},"required":["content_type","filename","url"],"title":"WhatsAppAttachmentData"},"CreateWhatsAppMessage":{"type":"object","properties":{"activity_at":{"type":"string","format":"date-time"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/WhatsAppAttachmentData"}},"contact_id":{"type":"string"},"direction":{"$ref":"#/components/schemas/CommunicationDirection"},"external_whatsapp_message_id":{"type":"string"},"integration_link":{"type":["string","null"],"format":"uri","minLength":1,"maxLength":2083,"default":null},"lead_id":{"type":"string"},"local_phone":{"type":"string"},"message_markdown":{"type":"string"},"remote_phone":{"type":"string"},"response_to_id":{"type":["string","null"],"default":null},"user_id":{"type":["string","null"]}},"required":["activity_at","contact_id","direction","external_whatsapp_message_id","lead_id","local_phone","message_markdown","remote_phone"],"title":"CreateWhatsAppMessage"},"UpdateWhatsAppMessage":{"type":"object","properties":{"activity_at":{"type":"string","format":"date-time"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/WhatsAppAttachmentData"}},"contact_id":{"type":"string"},"direction":{"$ref":"#/components/schemas/CommunicationDirection"},"integration_link":{"type":["string","null"],"format":"uri","minLength":1,"maxLength":2083},"local_phone":{"type":"string"},"message_markdown":{"type":"string"},"remote_phone":{"type":"string"},"response_to_id":{"type":["string","null"]},"user_id":{"type":"string"}},"title":"UpdateWhatsAppMessage"},"activities.whatsapp_messages_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"activities.whatsapp_messages_delete_Response_200"},"ActivityMeetingGetParametersDateCreatedGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityMeetingGetParametersDateCreatedGte"},"ActivityMeetingGetParametersDateCreatedLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityMeetingGetParametersDateCreatedLte"},"ActivityMeetingGetParametersDateCreatedGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityMeetingGetParametersDateCreatedGt"},"ActivityMeetingGetParametersDateCreatedLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityMeetingGetParametersDateCreatedLt"},"ActivityMeetingGetParametersActivityAtGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityMeetingGetParametersActivityAtGte"},"ActivityMeetingGetParametersActivityAtLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityMeetingGetParametersActivityAtLte"},"ActivityMeetingGetParametersActivityAtGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityMeetingGetParametersActivityAtGt"},"ActivityMeetingGetParametersActivityAtLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityMeetingGetParametersActivityAtLt"},"MeetingPausedSubscription":{"type":"object","properties":{"contact_id":{"type":["string","null"]},"contact_name":{"type":["string","null"]},"id":{"type":"string"},"sequence_id":{"type":"string"},"sequence_name":{"type":"string"},"sequence_status":{"type":"string"}},"required":["contact_id","contact_name","id","sequence_id","sequence_name","sequence_status"],"title":"MeetingPausedSubscription"},"MeetingAttendee":{"type":"object","properties":{"contact_id":{"type":["string","null"]},"email":{"type":["string","null"]},"is_organizer":{"type":["boolean","null"]},"name":{"type":["string","null"]},"status":{"type":["string","null"]},"user_id":{"type":["string","null"]}},"required":["contact_id","email","is_organizer","name","status","user_id"],"title":"MeetingAttendee"},"ConferenceLinkType":{"type":"string","enum":["ZOOM","GOOGLE_MEET","GOOGLE_HANGOUTS","MICROSOFT_TEAMS","SKYPE","WEBEX","GO_TO_MEETING"],"title":"ConferenceLinkType"},"MeetingConferenceLink":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ConferenceLinkType"},"url":{"type":"string"}},"required":["type","url"],"title":"MeetingConferenceLink"},"PlaybookReason":{"type":"string","enum":["user-selected","autodetected"],"title":"PlaybookReason"},"OutcomeAutofillConfidence":{"type":"string","enum":["low","medium","high"],"title":"OutcomeAutofillConfidence"},"OutcomeReason":{"type":"string","enum":["autofilled","user-selected","voicemail-dropped"],"title":"OutcomeReason"},"ProviderCalendarType":{"type":"string","enum":["google","microsoft"],"title":"ProviderCalendarType"},"MeetingSource":{"type":"string","enum":["calendar","manual"],"title":"MeetingSource"},"MeetingStatus":{"type":"string","enum":["upcoming","in-progress","completed","canceled","declined-by-org","declined-by-lead"],"title":"MeetingStatus"},"MeetingSummary":{"type":"object","properties":{"html":{"type":"string"},"text":{"type":"string"}},"required":["html","text"],"title":"MeetingSummary"},"SpeakerSide":{"type":"string","enum":["contact","close-user","voice-agent"],"title":"SpeakerSide"},"MeetingTranscriptSpeaker":{"type":"object","properties":{"speaker_label":{"type":"string"},"speaker_side":{"oneOf":[{"$ref":"#/components/schemas/SpeakerSide"},{"type":"null"}]},"talk_percentage":{"type":"number","format":"double"},"talk_time":{"type":"number","format":"double"}},"required":["speaker_label","speaker_side","talk_percentage","talk_time"],"title":"MeetingTranscriptSpeaker"},"MeetingTranscriptWord":{"type":"object","properties":{"end":{"type":["number","null"],"format":"double"},"start":{"type":["number","null"],"format":"double"},"text":{"type":"string"}},"required":["end","start","text"],"title":"MeetingTranscriptWord"},"MeetingTranscriptUtterance":{"type":"object","properties":{"end":{"type":"number","format":"double"},"speaker_label":{"type":"string"},"speaker_side":{"oneOf":[{"$ref":"#/components/schemas/SpeakerSide"},{"type":"null"}]},"start":{"type":"number","format":"double"},"text":{"type":"string"},"words":{"type":"array","items":{"$ref":"#/components/schemas/MeetingTranscriptWord"}}},"required":["end","speaker_label","speaker_side","start","text"],"title":"MeetingTranscriptUtterance"},"MeetingTranscript":{"type":"object","properties":{"has_speaker_labels":{"type":"boolean"},"id":{"type":"string"},"speakers":{"type":"array","items":{"$ref":"#/components/schemas/MeetingTranscriptSpeaker"}},"summary_html":{"type":["string","null"]},"summary_text":{"type":["string","null"]},"utterances":{"type":"array","items":{"$ref":"#/components/schemas/MeetingTranscriptUtterance"}}},"required":["has_speaker_labels","id","speakers","summary_text","utterances"],"title":"MeetingTranscript"},"MeetingActivity":{"type":"object","properties":{"_paused_subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/MeetingPausedSubscription"}},"_type":{"type":"string"},"activity_at":{"type":["string","null"],"format":"date-time"},"actual_duration":{"type":["integer","null"]},"attached_call_ids":{"type":"array","items":{"type":"string"}},"attendees":{"type":"array","items":{"$ref":"#/components/schemas/MeetingAttendee"}},"calendar_event_link":{"type":["string","null"]},"calendar_event_uids":{"type":"array","items":{"type":"string"}},"comment_summary":{"oneOf":[{"$ref":"#/components/schemas/CommentSummary"},{"type":"null"}]},"conference_links":{"type":"array","items":{"$ref":"#/components/schemas/MeetingConferenceLink"}},"connected_account_id":{"type":["string","null"]},"contact_id":{"type":["string","null"]},"conversation_type_id":{"type":["string","null"]},"conversation_type_reason":{"oneOf":[{"$ref":"#/components/schemas/PlaybookReason"},{"type":"null"}]},"created_by":{"type":["string","null"]},"created_by_name":{"type":["string","null"],"default":null},"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"duration":{"type":"integer"},"ends_at":{"type":"string","format":"date-time"},"id":{"type":"string"},"integrations":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}}},"is_recurring":{"type":"boolean"},"lead_id":{"type":["string","null"]},"location":{"type":"string"},"note":{"type":"string"},"notetaker_id":{"type":["string","null"]},"organization_id":{"type":"string"},"outcome_autofill_confidence":{"oneOf":[{"$ref":"#/components/schemas/OutcomeAutofillConfidence"},{"type":"null"}]},"outcome_autofill_reasoning":{"type":["string","null"]},"outcome_id":{"type":["string","null"]},"outcome_reason":{"oneOf":[{"$ref":"#/components/schemas/OutcomeReason"},{"type":"null"}]},"playbook_id":{"type":["string","null"]},"playbook_reason":{"oneOf":[{"$ref":"#/components/schemas/PlaybookReason"},{"type":"null"}]},"provider_calendar_event_id":{"type":["string","null"]},"provider_calendar_ids":{"type":"array","items":{"type":"string"}},"provider_calendar_type":{"oneOf":[{"$ref":"#/components/schemas/ProviderCalendarType"},{"type":"null"}]},"source":{"$ref":"#/components/schemas/MeetingSource"},"starts_at":{"type":"string","format":"date-time"},"status":{"oneOf":[{"$ref":"#/components/schemas/MeetingStatus"},{"type":"null"}]},"summary":{"oneOf":[{"$ref":"#/components/schemas/MeetingSummary"},{"type":"null"}]},"title":{"type":"string"},"transcripts":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/MeetingTranscript"},{"type":"null"}]}},"updated_by":{"type":["string","null"]},"updated_by_name":{"type":["string","null"],"default":null},"user_id":{"type":["string","null"]},"user_name":{"type":["string","null"],"default":null},"user_note":{"type":["string","null"]},"user_note_date_updated":{"type":["string","null"],"format":"date-time"},"user_note_html":{"type":["string","null"]},"user_note_mentions":{"type":"array","items":{"type":"string"}},"users":{"type":"array","items":{"type":"string"}}},"required":["_type","activity_at","actual_duration","attached_call_ids","attendees","calendar_event_link","calendar_event_uids","conference_links","connected_account_id","contact_id","conversation_type_id","conversation_type_reason","created_by","date_created","date_updated","duration","ends_at","id","integrations","is_recurring","lead_id","location","note","notetaker_id","organization_id","outcome_autofill_confidence","outcome_autofill_reasoning","outcome_id","outcome_reason","playbook_id","playbook_reason","provider_calendar_event_id","provider_calendar_ids","provider_calendar_type","source","starts_at","status","summary","title","updated_by","user_id","user_note","user_note_date_updated","user_note_html","user_note_mentions","users"],"title":"MeetingActivity"},"activities.meetings_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MeetingActivity"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"activities.meetings_list_Response_200"},"activities.meetings_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"activities.meetings_delete_Response_200"},"activities.meetings_createIntegration_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"activities.meetings_createIntegration_Response_200"},"ActivityCustomGetParametersDateCreatedGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCustomGetParametersDateCreatedGte"},"ActivityCustomGetParametersDateCreatedLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCustomGetParametersDateCreatedLte"},"ActivityCustomGetParametersDateCreatedGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCustomGetParametersDateCreatedGt"},"ActivityCustomGetParametersDateCreatedLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCustomGetParametersDateCreatedLt"},"ActivityCustomGetParametersActivityAtGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCustomGetParametersActivityAtGte"},"ActivityCustomGetParametersActivityAtLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCustomGetParametersActivityAtLte"},"ActivityCustomGetParametersActivityAtGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCustomGetParametersActivityAtGt"},"ActivityCustomGetParametersActivityAtLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCustomGetParametersActivityAtLt"},"CustomActivityStatus":{"type":"string","enum":["draft","published"],"title":"CustomActivityStatus"},"CustomActivity":{"type":"object","properties":{"_type":{"type":"string"},"activity_at":{"type":["string","null"],"format":"date-time"},"comment_summary":{"oneOf":[{"$ref":"#/components/schemas/CommentSummary"},{"type":"null"}]},"contact_id":{"type":["string","null"]},"created_by":{"type":["string","null"]},"created_by_name":{"type":["string","null"],"default":null},"custom_activity_type_id":{"type":"string"},"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"id":{"type":"string"},"last_published_at":{"type":["string","null"],"format":"date-time"},"lead_id":{"type":["string","null"]},"mentions":{"type":"array","items":{"type":"string"}},"mentions_updated_at":{"type":["string","null"],"format":"date-time"},"organization_id":{"type":"string"},"pinned":{"type":"boolean"},"pinned_at":{"type":["string","null"],"format":"date-time"},"source":{"oneOf":[{"$ref":"#/components/schemas/CreationSource"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/CustomActivityStatus"},"updated_by":{"type":["string","null"]},"updated_by_name":{"type":["string","null"],"default":null},"user_id":{"type":["string","null"]},"user_name":{"type":["string","null"],"default":null},"users":{"type":"array","items":{"type":"string"}}},"required":["_type","activity_at","contact_id","created_by","custom_activity_type_id","date_created","date_updated","id","last_published_at","lead_id","mentions","mentions_updated_at","organization_id","pinned","pinned_at","source","status","updated_by","user_id","users"],"title":"CustomActivity"},"activities.custom_activities_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomActivity"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"activities.custom_activities_list_Response_200"},"CreateCustomActivityStatus":{"type":"string","enum":["draft","published"],"title":"CreateCustomActivityStatus"},"CreateCustomActivity":{"type":"object","properties":{"activity_at":{"type":["string","null"],"format":"date-time"},"contact_id":{"type":["string","null"]},"created_by":{"type":["string","null"]},"custom_activity_type_id":{"type":"string"},"date_created":{"type":["string","null"],"format":"date-time"},"lead_id":{"type":"string"},"organization_id":{"type":["string","null"]},"pinned":{"type":["boolean","null"]},"status":{"$ref":"#/components/schemas/CreateCustomActivityStatus"},"user_id":{"type":["string","null"]}},"required":["custom_activity_type_id","lead_id"],"title":"CreateCustomActivity"},"UpdateCustomActivityStatus":{"type":"string","enum":["draft","published"],"title":"UpdateCustomActivityStatus"},"UpdateCustomActivity":{"type":"object","properties":{"activity_at":{"type":["string","null"],"format":"date-time"},"contact_id":{"type":["string","null"]},"pinned":{"type":["boolean","null"]},"status":{"$ref":"#/components/schemas/UpdateCustomActivityStatus"}},"title":"UpdateCustomActivity"},"activities.custom_activities_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"activities.custom_activities_delete_Response_200"},"ActivityCreatedGetParametersDateCreatedGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCreatedGetParametersDateCreatedGte"},"ActivityCreatedGetParametersDateCreatedLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCreatedGetParametersDateCreatedLte"},"ActivityCreatedGetParametersDateCreatedGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCreatedGetParametersDateCreatedGt"},"ActivityCreatedGetParametersDateCreatedLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCreatedGetParametersDateCreatedLt"},"ActivityCreatedGetParametersActivityAtGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCreatedGetParametersActivityAtGte"},"ActivityCreatedGetParametersActivityAtLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCreatedGetParametersActivityAtLte"},"ActivityCreatedGetParametersActivityAtGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCreatedGetParametersActivityAtGt"},"ActivityCreatedGetParametersActivityAtLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityCreatedGetParametersActivityAtLt"},"CreatedActivity":{"type":"object","properties":{"_type":{"type":"string"},"activity_at":{"type":["string","null"],"format":"date-time"},"contact_id":{"type":["string","null"]},"created_by":{"type":["string","null"]},"created_by_name":{"type":["string","null"],"default":null},"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"id":{"type":"string"},"import_id":{"type":["string","null"]},"lead_id":{"type":["string","null"]},"organization_id":{"type":"string"},"source":{"oneOf":[{"$ref":"#/components/schemas/CreationSource"},{"type":"null"}]},"updated_by":{"type":["string","null"]},"updated_by_name":{"type":["string","null"],"default":null},"user_id":{"type":["string","null"]},"user_name":{"type":["string","null"],"default":null},"users":{"type":"array","items":{"type":"string"}}},"required":["_type","activity_at","contact_id","created_by","date_created","date_updated","id","import_id","lead_id","organization_id","source","updated_by","user_id","users"],"title":"CreatedActivity"},"activities.creations_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CreatedActivity"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"activities.creations_list_Response_200"},"ActivityFormSubmissionGetParametersDateCreatedGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityFormSubmissionGetParametersDateCreatedGte"},"ActivityFormSubmissionGetParametersDateCreatedLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityFormSubmissionGetParametersDateCreatedLte"},"ActivityFormSubmissionGetParametersDateCreatedGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityFormSubmissionGetParametersDateCreatedGt"},"ActivityFormSubmissionGetParametersDateCreatedLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityFormSubmissionGetParametersDateCreatedLt"},"ActivityFormSubmissionGetParametersActivityAtGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityFormSubmissionGetParametersActivityAtGte"},"ActivityFormSubmissionGetParametersActivityAtLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityFormSubmissionGetParametersActivityAtLte"},"ActivityFormSubmissionGetParametersActivityAtGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityFormSubmissionGetParametersActivityAtGt"},"ActivityFormSubmissionGetParametersActivityAtLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityFormSubmissionGetParametersActivityAtLt"},"FormSubmissionActivityValues":{"oneOf":[{"type":"string"},{"type":"boolean"}],"title":"FormSubmissionActivityValues"},"FormSubmissionActivityValuesByName":{"oneOf":[{"type":"string"},{"type":"boolean"}],"title":"FormSubmissionActivityValuesByName"},"FormSubmissionActivity":{"type":"object","properties":{"_type":{"type":"string"},"activity_at":{"type":["string","null"],"format":"date-time"},"contact_id":{"type":["string","null"]},"created_by":{"type":["string","null"]},"created_by_name":{"type":["string","null"],"default":null},"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"form_configuration_id":{"type":"string"},"form_id":{"type":"string"},"form_name":{"type":["string","null"],"default":null},"id":{"type":"string"},"ip_address":{"type":["string","null"]},"lead_id":{"type":["string","null"]},"organization_id":{"type":"string"},"origin":{"type":["string","null"]},"source_url":{"type":["string","null"]},"source_url_normalized":{"type":["string","null"]},"updated_by":{"type":["string","null"]},"updated_by_name":{"type":["string","null"],"default":null},"user_id":{"type":["string","null"]},"user_name":{"type":["string","null"],"default":null},"users":{"type":"array","items":{"type":"string"}},"values":{"type":"object","additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/FormSubmissionActivityValues"},{"type":"null"}]}},"values_by_name":{"type":"object","additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/FormSubmissionActivityValuesByName"},{"type":"null"}]}}},"required":["_type","activity_at","contact_id","created_by","date_created","date_updated","form_configuration_id","form_id","id","ip_address","lead_id","organization_id","origin","source_url","source_url_normalized","updated_by","user_id","users","values","values_by_name"],"title":"FormSubmissionActivity"},"activities.form_submissions_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FormSubmissionActivity"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"activities.form_submissions_list_Response_200"},"activities.form_submissions_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"activities.form_submissions_delete_Response_200"},"ActivityStatusChangeLeadGetParametersDateCreatedGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityStatusChangeLeadGetParametersDateCreatedGte"},"ActivityStatusChangeLeadGetParametersDateCreatedLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityStatusChangeLeadGetParametersDateCreatedLte"},"ActivityStatusChangeLeadGetParametersDateCreatedGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityStatusChangeLeadGetParametersDateCreatedGt"},"ActivityStatusChangeLeadGetParametersDateCreatedLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityStatusChangeLeadGetParametersDateCreatedLt"},"ActivityStatusChangeLeadGetParametersActivityAtGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityStatusChangeLeadGetParametersActivityAtGte"},"ActivityStatusChangeLeadGetParametersActivityAtLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityStatusChangeLeadGetParametersActivityAtLte"},"ActivityStatusChangeLeadGetParametersActivityAtGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityStatusChangeLeadGetParametersActivityAtGt"},"ActivityStatusChangeLeadGetParametersActivityAtLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityStatusChangeLeadGetParametersActivityAtLt"},"PausedSubscription":{"type":"object","properties":{"contact_id":{"type":["string","null"]},"contact_name":{"type":["string","null"]},"id":{"type":"string"},"sequence_id":{"type":"string"},"sequence_name":{"type":"string"},"sequence_status":{"type":"string"}},"required":["contact_id","contact_name","id","sequence_id","sequence_name","sequence_status"],"title":"PausedSubscription"},"LeadStatusChangeActivity":{"type":"object","properties":{"_paused_subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/PausedSubscription"}},"_type":{"type":"string"},"activity_at":{"type":["string","null"],"format":"date-time"},"contact_id":{"type":["string","null"]},"created_by":{"type":["string","null"]},"created_by_name":{"type":["string","null"],"default":null},"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"id":{"type":"string"},"lead_id":{"type":["string","null"]},"new_status_id":{"type":"string"},"new_status_label":{"type":"string"},"old_status_id":{"type":"string"},"old_status_label":{"type":"string"},"organization_id":{"type":"string"},"updated_by":{"type":["string","null"]},"updated_by_name":{"type":["string","null"],"default":null},"user_id":{"type":["string","null"]},"user_name":{"type":["string","null"],"default":null},"users":{"type":"array","items":{"type":"string"}}},"required":["_type","activity_at","contact_id","created_by","date_created","date_updated","id","lead_id","new_status_id","old_status_id","organization_id","updated_by","user_id","users"],"title":"LeadStatusChangeActivity"},"activities.lead_status_changes_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LeadStatusChangeActivity"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"activities.lead_status_changes_list_Response_200"},"activities.lead_status_changes_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"activities.lead_status_changes_delete_Response_200"},"ActivityStatusChangeOpportunityGetParametersDateCreatedGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityStatusChangeOpportunityGetParametersDateCreatedGte"},"ActivityStatusChangeOpportunityGetParametersDateCreatedLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityStatusChangeOpportunityGetParametersDateCreatedLte"},"ActivityStatusChangeOpportunityGetParametersDateCreatedGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityStatusChangeOpportunityGetParametersDateCreatedGt"},"ActivityStatusChangeOpportunityGetParametersDateCreatedLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityStatusChangeOpportunityGetParametersDateCreatedLt"},"ActivityStatusChangeOpportunityGetParametersActivityAtGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityStatusChangeOpportunityGetParametersActivityAtGte"},"ActivityStatusChangeOpportunityGetParametersActivityAtLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityStatusChangeOpportunityGetParametersActivityAtLte"},"ActivityStatusChangeOpportunityGetParametersActivityAtGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityStatusChangeOpportunityGetParametersActivityAtGt"},"ActivityStatusChangeOpportunityGetParametersActivityAtLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityStatusChangeOpportunityGetParametersActivityAtLt"},"OpportunityStatusChangeActivity":{"type":"object","properties":{"_type":{"type":"string"},"activity_at":{"type":["string","null"],"format":"date-time"},"contact_id":{"type":["string","null"]},"created_by":{"type":["string","null"]},"created_by_name":{"type":["string","null"],"default":null},"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"id":{"type":"string"},"lead_id":{"type":["string","null"]},"new_pipeline_id":{"type":"string"},"new_pipeline_name":{"type":"string"},"new_status_id":{"type":"string"},"new_status_label":{"type":"string"},"new_status_type":{"$ref":"#/components/schemas/OpportunityStatusType"},"old_pipeline_id":{"type":"string"},"old_pipeline_name":{"type":"string"},"old_status_id":{"type":"string"},"old_status_label":{"type":"string"},"old_status_type":{"$ref":"#/components/schemas/OpportunityStatusType"},"opportunity_confidence":{"type":["integer","null"]},"opportunity_date_won":{"type":["string","null"],"format":"date-time"},"opportunity_id":{"type":["string","null"]},"opportunity_value":{"type":["integer","null"]},"opportunity_value_currency":{"type":["string","null"]},"opportunity_value_formatted":{"type":["string","null"]},"opportunity_value_period":{"oneOf":[{"$ref":"#/components/schemas/OpportunityValuePeriod"},{"type":"null"}]},"organization_id":{"type":"string"},"updated_by":{"type":["string","null"]},"updated_by_name":{"type":["string","null"],"default":null},"user_id":{"type":["string","null"]},"user_name":{"type":["string","null"],"default":null},"users":{"type":"array","items":{"type":"string"}}},"required":["_type","activity_at","contact_id","created_by","date_created","date_updated","id","lead_id","new_status_id","old_status_id","opportunity_id","organization_id","updated_by","user_id","users"],"title":"OpportunityStatusChangeActivity"},"activities.opportunity_status_changes_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OpportunityStatusChangeActivity"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"activities.opportunity_status_changes_list_Response_200"},"activities.opportunity_status_changes_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"activities.opportunity_status_changes_delete_Response_200"},"ActivityLeadMergeGetParametersDateCreatedGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityLeadMergeGetParametersDateCreatedGte"},"ActivityLeadMergeGetParametersDateCreatedLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityLeadMergeGetParametersDateCreatedLte"},"ActivityLeadMergeGetParametersDateCreatedGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityLeadMergeGetParametersDateCreatedGt"},"ActivityLeadMergeGetParametersDateCreatedLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityLeadMergeGetParametersDateCreatedLt"},"ActivityLeadMergeGetParametersActivityAtGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityLeadMergeGetParametersActivityAtGte"},"ActivityLeadMergeGetParametersActivityAtLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityLeadMergeGetParametersActivityAtLte"},"ActivityLeadMergeGetParametersActivityAtGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityLeadMergeGetParametersActivityAtGt"},"ActivityLeadMergeGetParametersActivityAtLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityLeadMergeGetParametersActivityAtLt"},"LeadMergeStatus":{"type":"string","enum":["pending","in_progress","completed","errored"],"title":"LeadMergeStatus"},"LeadMergeActivity":{"type":"object","properties":{"_type":{"type":"string"},"activity_at":{"type":["string","null"],"format":"date-time"},"contact_id":{"type":["string","null"]},"created_by":{"type":["string","null"]},"created_by_name":{"type":["string","null"],"default":null},"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"destination_display_name":{"type":["string","null"]},"destination_lead_id":{"type":"string"},"error_message":{"type":["string","null"]},"id":{"type":"string"},"lead_id":{"type":["string","null"]},"merge_status":{"$ref":"#/components/schemas/LeadMergeStatus"},"organization_id":{"type":"string"},"source_display_name":{"type":["string","null"]},"source_lead_id":{"type":"string"},"updated_by":{"type":["string","null"]},"updated_by_name":{"type":["string","null"],"default":null},"user_id":{"type":["string","null"]},"user_name":{"type":["string","null"],"default":null},"users":{"type":"array","items":{"type":"string"}}},"required":["_type","activity_at","contact_id","created_by","date_created","date_updated","destination_display_name","destination_lead_id","error_message","id","lead_id","merge_status","organization_id","source_display_name","source_lead_id","updated_by","user_id","users"],"title":"LeadMergeActivity"},"activities.lead_merges_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LeadMergeActivity"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"activities.lead_merges_list_Response_200"},"ActivityTaskCompletedGetParametersDateCreatedGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityTaskCompletedGetParametersDateCreatedGte"},"ActivityTaskCompletedGetParametersDateCreatedLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityTaskCompletedGetParametersDateCreatedLte"},"ActivityTaskCompletedGetParametersDateCreatedGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityTaskCompletedGetParametersDateCreatedGt"},"ActivityTaskCompletedGetParametersDateCreatedLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityTaskCompletedGetParametersDateCreatedLt"},"ActivityTaskCompletedGetParametersActivityAtGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityTaskCompletedGetParametersActivityAtGte"},"ActivityTaskCompletedGetParametersActivityAtLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityTaskCompletedGetParametersActivityAtLte"},"ActivityTaskCompletedGetParametersActivityAtGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityTaskCompletedGetParametersActivityAtGt"},"ActivityTaskCompletedGetParametersActivityAtLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityTaskCompletedGetParametersActivityAtLt"},"TaskCompletedActivity":{"type":"object","properties":{"_type":{"type":"string"},"activity_at":{"type":["string","null"],"format":"date-time"},"comment_summary":{"oneOf":[{"$ref":"#/components/schemas/CommentSummary"},{"type":"null"}]},"created_by":{"type":["string","null"]},"created_by_name":{"type":["string","null"],"default":null},"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"id":{"type":"string"},"lead_id":{"type":["string","null"]},"organization_id":{"type":"string"},"sequence_id":{"type":["string","null"]},"sequence_name":{"type":["string","null"]},"sequence_subscription_id":{"type":["string","null"]},"task_assigned_to":{"type":["string","null"]},"task_assigned_to_name":{"type":["string","null"]},"task_id":{"type":["string","null"]},"task_text":{"type":["string","null"]},"updated_by":{"type":["string","null"]},"updated_by_name":{"type":["string","null"],"default":null},"user_id":{"type":["string","null"]},"user_name":{"type":["string","null"],"default":null},"users":{"type":"array","items":{"type":"string"}}},"required":["_type","activity_at","created_by","date_created","date_updated","id","lead_id","organization_id","task_id","task_text","updated_by","user_id","users"],"title":"TaskCompletedActivity"},"activities.task_completions_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TaskCompletedActivity"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"activities.task_completions_list_Response_200"},"activities.task_completions_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"activities.task_completions_delete_Response_200"},"ActivityImportUpdateGetParametersDateCreatedGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityImportUpdateGetParametersDateCreatedGte"},"ActivityImportUpdateGetParametersDateCreatedLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityImportUpdateGetParametersDateCreatedLte"},"ActivityImportUpdateGetParametersDateCreatedGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityImportUpdateGetParametersDateCreatedGt"},"ActivityImportUpdateGetParametersDateCreatedLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityImportUpdateGetParametersDateCreatedLt"},"ActivityImportUpdateGetParametersActivityAtGte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityImportUpdateGetParametersActivityAtGte"},"ActivityImportUpdateGetParametersActivityAtLte":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityImportUpdateGetParametersActivityAtLte"},"ActivityImportUpdateGetParametersActivityAtGt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityImportUpdateGetParametersActivityAtGt"},"ActivityImportUpdateGetParametersActivityAtLt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"}],"title":"ActivityImportUpdateGetParametersActivityAtLt"},"ImportUpdateActivity":{"type":"object","properties":{"_type":{"type":"string"},"activity_at":{"type":["string","null"],"format":"date-time"},"contact_id":{"type":["string","null"]},"created_by":{"type":["string","null"]},"created_by_name":{"type":["string","null"],"default":null},"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"id":{"type":"string"},"import_id":{"type":["string","null"]},"lead_id":{"type":["string","null"]},"organization_id":{"type":"string"},"reverted":{"type":"boolean"},"updated_by":{"type":["string","null"]},"updated_by_name":{"type":["string","null"],"default":null},"user_id":{"type":["string","null"]},"user_name":{"type":["string","null"],"default":null},"users":{"type":"array","items":{"type":"string"}}},"required":["_type","activity_at","contact_id","created_by","date_created","date_updated","id","import_id","lead_id","organization_id","reverted","updated_by","user_id","users"],"title":"ImportUpdateActivity"},"activities.import_updates_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ImportUpdateActivity"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"activities.import_updates_list_Response_200"},"activities.import_updates_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"activities.import_updates_delete_Response_200"},"webhooks_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"webhooks_list_Response_200"},"WebhookSubscriptionEvent":{"type":"object","properties":{"action":{"type":"string"},"extra_filter":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"default":null},"object_type":{"type":"string"}},"required":["action","object_type"],"title":"WebhookSubscriptionEvent"},"CreateWebhook":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/WebhookSubscriptionEvent"},"description":"A list of events to subscribe to. Each event has an `object_type` and an `action` from values in the [event log](https://developer.close.com/api/resources/events/list-of-event-types). You can also use [Webhook Filters](https://developer.close.com/api/resources/webhooks/webhook-filters) while creating your subscription so that an event only fires to a Webhook when certain conditions are met."},"url":{"type":"string","description":"Destination URL for the webhook subscription"},"verify_ssl":{"type":"boolean","default":true,"description":"Verify SSL certificate of destination webhook URL. Set to `false` to disable SSL certificate validation. We recommend using https to protect your data during delivery."}},"required":["events","url"],"title":"CreateWebhook"},"webhooks_create_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"webhooks_create_Response_201"},"webhooks_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"webhooks_get_Response_200"},"WebhookStatus":{"type":"string","enum":["active","paused"],"title":"WebhookStatus"},"UpdateWebhook":{"type":"object","properties":{"events":{"type":["array","null"],"items":{"$ref":"#/components/schemas/WebhookSubscriptionEvent"},"default":null,"description":"A list of events to subscribe to. Each event has an `object_type` and an `action` from values in the [event log](https://developer.close.com/api/resources/events/list-of-event-types). You can also use [Webhook Filters](https://developer.close.com/api/resources/webhooks/webhook-filters) while creating your subscription so that an event only fires to a Webhook when certain conditions are met."},"status":{"oneOf":[{"$ref":"#/components/schemas/WebhookStatus"},{"type":"null"}],"default":null},"url":{"type":["string","null"],"default":null,"description":"Destination URL for the webhook subscription"},"verify_ssl":{"type":["boolean","null"],"default":null,"description":"Verify SSL certificate of destination webhook URL. Set to `false` to disable SSL certificate validation. We recommend using https to protect your data during delivery."}},"title":"UpdateWebhook"},"webhooks_update_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"webhooks_update_Response_200"},"webhooks_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"webhooks_delete_Response_200"},"events_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"events_list_Response_200"},"events_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"events_get_Response_200"},"SavedSearchType":{"type":"string","enum":["lead","contact","opportunity","call","email","sms","meeting","note","whatsapp_message","custom_activity","form_submission"],"title":"SavedSearchType"},"SharingSettingsEmbeddedResponse":{"type":"object","properties":{"created_at":{"type":["string","null"],"format":"date-time"},"created_by_id":{"type":["string","null"]},"group_ids":{"type":"array","items":{"type":"string"}},"updated_at":{"type":["string","null"],"format":"date-time"},"updated_by_id":{"type":["string","null"]},"user_ids":{"type":"array","items":{"type":"string"}},"whole_org":{"type":"boolean"}},"required":["created_at","created_by_id","group_ids","updated_at","updated_by_id","user_ids","whole_org"],"title":"SharingSettingsEmbeddedResponse"},"SavedSearch":{"type":"object","properties":{"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"description":{"type":["string","null"]},"id":{"type":"string"},"is_shared":{"type":"boolean"},"is_user_dependent":{"type":["boolean","null"]},"name":{"type":"string"},"organization_id":{"type":"string"},"query":{"type":["string","null"]},"s_query":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"selected_fields":{"type":["array","null"],"items":{"type":"object","additionalProperties":{"description":"Any type"}},"default":null},"shared_with":{"type":["array","null"],"items":{"type":"string"},"default":null},"sharing_settings":{"oneOf":[{"$ref":"#/components/schemas/SharingSettingsEmbeddedResponse"},{"type":"null"}],"default":null},"type":{"$ref":"#/components/schemas/SavedSearchType"},"user_id":{"type":["string","null"]}},"required":["date_created","date_updated","description","id","is_shared","is_user_dependent","name","organization_id","query","s_query","type","user_id"],"title":"SavedSearch"},"smart_views_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SavedSearch"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"smart_views_list_Response_200"},"smart_views_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"smart_views_delete_Response_200"},"reporting_getActivity_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"reporting_getActivity_Response_200"},"reporting_listActivityMetrics_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"reporting_listActivityMetrics_Response_200"},"ReportCustomOrgIdGetParametersTransformY":{"type":"string","enum":["sum","avg","min","max"],"title":"ReportCustomOrgIdGetParametersTransformY"},"reporting_getCustom_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"reporting_getCustom_Response_200"},"reporting_getFunnelStages_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"reporting_getFunnelStages_Response_200"},"reporting_getFunnelTotals_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"reporting_getFunnelTotals_Response_200"},"reporting_getSentEmails_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"reporting_getSentEmails_Response_200"},"reporting_getLeadStatuses_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"reporting_getLeadStatuses_Response_200"},"reporting_getOpportunityStatuses_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"reporting_getOpportunityStatuses_Response_200"},"sequences_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"sequences_list_Response_200"},"sequences_create_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"sequences_create_Response_200"},"sequences_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"sequences_get_Response_200"},"sequences_update_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"sequences_update_Response_200"},"sequences_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"sequences_delete_Response_200"},"sequences_listSubscriptions_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"sequences_listSubscriptions_Response_200"},"sequences_createSubscription_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"sequences_createSubscription_Response_201"},"sequences_getSubscription_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"sequences_getSubscription_Response_200"},"sequences_updateSubscription_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"sequences_updateSubscription_Response_200"},"sequences_deleteSubscription_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"sequences_deleteSubscription_Response_200"},"BulkEmailContactPreference":{"type":"string","enum":["lead","contact","all"],"title":"BulkEmailContactPreference"},"BulkActionStatus":{"type":"string","enum":["created","loading","processing","done","paused","resuming","error"],"title":"BulkActionStatus"},"BulkEmailAction":{"type":"object","properties":{"contact_preference":{"oneOf":[{"$ref":"#/components/schemas/BulkEmailContactPreference"},{"type":"null"}]},"created_by":{"type":["string","null"]},"date_created":{"type":["string","null"],"format":"date-time"},"date_updated":{"type":["string","null"],"format":"date-time"},"email_account_id":{"type":["string","null"]},"id":{"type":"string"},"n_leads":{"type":["integer","null"]},"n_leads_processed":{"type":"integer"},"n_objects":{"type":["integer","null"]},"n_objects_processed":{"type":"integer"},"organization_id":{"type":"string"},"query":{"type":["string","null"]},"results_limit":{"type":["integer","null"]},"s_query":{"type":"object","additionalProperties":{"description":"Any type"}},"send_done_email":{"type":"boolean"},"sender":{"type":["string","null"]},"sort":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}}},"status":{"oneOf":[{"$ref":"#/components/schemas/BulkActionStatus"},{"type":"null"}]},"template_id":{"type":["string","null"]},"updated_by":{"type":["string","null"]}},"required":["contact_preference","created_by","date_created","date_updated","email_account_id","id","n_leads","n_leads_processed","n_objects","n_objects_processed","organization_id","query","results_limit","s_query","send_done_email","sender","sort","status","template_id","updated_by"],"title":"BulkEmailAction"},"bulk_actions.email_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkEmailAction"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"bulk_actions.email_list_Response_200"},"BulkEditActionType":{"type":"string","enum":["set_custom_field","clear_custom_field","set_lead_status","set_contact_custom_field","clear_contact_custom_field","set_activity_custom_field","clear_activity_custom_field","set_global_custom_field","clear_global_custom_field","set_opportunity_custom_field","clear_opportunity_custom_field","set_custom_object_custom_field","clear_custom_object_custom_field"],"title":"BulkEditActionType"},"BulkEditAction":{"type":"object","properties":{"created_by":{"type":["string","null"]},"custom_field_name":{"type":["string","null"]},"custom_field_value":{"type":["string","null"]},"date_created":{"type":["string","null"],"format":"date-time"},"date_updated":{"type":["string","null"],"format":"date-time"},"id":{"type":"string"},"lead_status_id":{"type":["string","null"]},"n_leads":{"type":["integer","null"]},"n_leads_processed":{"type":"integer"},"n_objects":{"type":["integer","null"]},"n_objects_processed":{"type":"integer"},"organization_id":{"type":"string"},"query":{"type":["string","null"]},"results_limit":{"type":["integer","null"]},"s_query":{"type":"object","additionalProperties":{"description":"Any type"}},"send_done_email":{"type":"boolean"},"sort":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}}},"status":{"oneOf":[{"$ref":"#/components/schemas/BulkActionStatus"},{"type":"null"}]},"type":{"$ref":"#/components/schemas/BulkEditActionType"},"updated_by":{"type":["string","null"]}},"required":["created_by","custom_field_name","custom_field_value","date_created","date_updated","id","lead_status_id","n_leads","n_leads_processed","n_objects","n_objects_processed","organization_id","query","results_limit","s_query","send_done_email","sort","status","type","updated_by"],"title":"BulkEditAction"},"bulk_actions.edit_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkEditAction"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"bulk_actions.edit_list_Response_200"},"BulkActionObjectType":{"type":"string","enum":["lead","contact","call","custom_activity","form_submission"],"title":"BulkActionObjectType"},"BulkDeleteAction":{"type":"object","properties":{"bulk_object_type":{"$ref":"#/components/schemas/BulkActionObjectType"},"created_by":{"type":["string","null"]},"date_created":{"type":["string","null"],"format":"date-time"},"date_updated":{"type":["string","null"],"format":"date-time"},"id":{"type":"string"},"n_leads":{"type":["integer","null"]},"n_leads_processed":{"type":"integer"},"n_objects":{"type":["integer","null"]},"n_objects_processed":{"type":"integer"},"organization_id":{"type":"string"},"query":{"type":["string","null"]},"results_limit":{"type":["integer","null"]},"s_query":{"type":"object","additionalProperties":{"description":"Any type"}},"send_done_email":{"type":"boolean"},"sort":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}}},"status":{"oneOf":[{"$ref":"#/components/schemas/BulkActionStatus"},{"type":"null"}]},"updated_by":{"type":["string","null"]}},"required":["bulk_object_type","created_by","date_created","date_updated","id","n_leads","n_leads_processed","n_objects","n_objects_processed","organization_id","query","results_limit","s_query","send_done_email","sort","status","updated_by"],"title":"BulkDeleteAction"},"bulk_actions.delete_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkDeleteAction"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"bulk_actions.delete_list_Response_200"},"BulkSequenceSubscriptionActionType":{"type":"string","enum":["subscribe","resume","resume_finished","pause","reassign"],"title":"BulkSequenceSubscriptionActionType"},"BulkSequenceSubscriptionContactPreference":{"type":"string","enum":["lead","contact"],"title":"BulkSequenceSubscriptionContactPreference"},"BulkSequenceSubscriptionAction":{"type":"object","properties":{"action_type":{"$ref":"#/components/schemas/BulkSequenceSubscriptionActionType"},"caller_id_mode":{"oneOf":[{"$ref":"#/components/schemas/CallerIdMode"},{"type":"null"}]},"calls_assigned_to":{"type":["array","null"],"items":{"type":"string"}},"contact_preference":{"oneOf":[{"$ref":"#/components/schemas/BulkSequenceSubscriptionContactPreference"},{"type":"null"}]},"created_by":{"type":["string","null"]},"date_created":{"type":["string","null"],"format":"date-time"},"date_updated":{"type":["string","null"],"format":"date-time"},"from_phone_number_id":{"type":["string","null"]},"id":{"type":"string"},"n_leads":{"type":["integer","null"]},"n_leads_processed":{"type":"integer"},"n_objects":{"type":["integer","null"]},"n_objects_processed":{"type":"integer"},"organization_id":{"type":"string"},"query":{"type":["string","null"]},"results_limit":{"type":["integer","null"]},"s_query":{"type":"object","additionalProperties":{"description":"Any type"}},"send_done_email":{"type":"boolean"},"sender_account_id":{"type":["string","null"]},"sender_email":{"type":["string","null"]},"sender_name":{"type":["string","null"]},"sequence_id":{"type":["string","null"]},"sort":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}}},"status":{"oneOf":[{"$ref":"#/components/schemas/BulkActionStatus"},{"type":"null"}]},"updated_by":{"type":["string","null"]}},"required":["action_type","caller_id_mode","calls_assigned_to","contact_preference","created_by","date_created","date_updated","from_phone_number_id","id","n_leads","n_leads_processed","n_objects","n_objects_processed","organization_id","query","results_limit","s_query","send_done_email","sender_account_id","sender_email","sender_name","sequence_id","sort","status","updated_by"],"title":"BulkSequenceSubscriptionAction"},"bulk_actions.sequence_subscriptions_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkSequenceSubscriptionAction"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"bulk_actions.sequence_subscriptions_list_Response_200"},"ExportDateFormat":{"type":"string","enum":["original","iso8601","excel"],"title":"ExportDateFormat"},"ExportFormat":{"type":"string","enum":["csv","json"],"title":"ExportFormat"},"Json1":{"type":"array","items":{"$ref":"#/components/schemas/JSON"},"title":"Json1"},"Json":{"oneOf":[{"$ref":"#/components/schemas/JSONDict"},{"$ref":"#/components/schemas/Json1"},{"type":"string"},{"type":"integer"},{"type":"number","format":"double"},{"type":"boolean"}],"title":"Json"},"JSON":{"oneOf":[{"$ref":"#/components/schemas/Json"},{"type":"null"}],"title":"JSON"},"JSONDict":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JSON"},"title":"JSONDict"},"ExportStatus":{"type":"string","enum":["created","started","in_progress","done","error"],"title":"ExportStatus"},"ExportType":{"type":"string","enum":["leads","contacts","lead_opps","opps","opportunities"],"title":"ExportType"},"Export":{"type":"object","properties":{"created_by":{"type":["string","null"]},"date_created":{"type":"string","format":"date-time"},"date_format":{"$ref":"#/components/schemas/ExportDateFormat"},"date_updated":{"type":"string","format":"date-time"},"download_url":{"type":["string","null"]},"fields":{"type":"array","items":{"type":"string"}},"format":{"$ref":"#/components/schemas/ExportFormat"},"id":{"type":"string"},"limit":{"type":["integer","null"],"default":null},"n_docs":{"type":["integer","null"]},"n_docs_processed":{"type":"integer"},"organization_id":{"type":"string"},"params":{"oneOf":[{"$ref":"#/components/schemas/JSONDict"},{"type":"null"}],"default":null},"query":{"type":["string","null"],"default":null},"results_limit":{"type":["integer","null"],"default":null},"s_query":{"oneOf":[{"$ref":"#/components/schemas/JSONDict"},{"type":"null"}],"default":null},"send_done_email":{"type":"boolean"},"sort":{"type":["array","null"],"items":{"$ref":"#/components/schemas/JSONDict"},"default":null},"status":{"$ref":"#/components/schemas/ExportStatus"},"type":{"$ref":"#/components/schemas/ExportType"},"updated_by":{"type":["string","null"]}},"required":["created_by","date_created","date_format","date_updated","download_url","fields","format","id","n_docs","n_docs_processed","organization_id","send_done_email","status","type","updated_by"],"title":"Export"},"exports_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Export"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"exports_list_Response_200"},"exports_listLead_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Export"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"exports_listLead_Response_200"},"exports_listOpportunity_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Export"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"exports_listOpportunity_Response_200"},"RunFieldEnrichmentObjectType":{"type":"string","enum":["lead","contact"],"title":"RunFieldEnrichmentObjectType"},"RunFieldEnrichment":{"type":"object","properties":{"field_id":{"type":"string"},"object_id":{"type":"string"},"object_type":{"$ref":"#/components/schemas/RunFieldEnrichmentObjectType"},"organization_id":{"type":"string"},"overwrite_existing_value":{"type":"boolean","default":false},"set_new_value":{"type":"boolean","default":true}},"required":["field_id","object_id","object_type","organization_id"],"title":"RunFieldEnrichment"},"field_enrichment_create_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"field_enrichment_create_Response_200"},"custom_field_schemas_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_field_schemas_get_Response_200"},"custom_field_schemas_update_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_field_schemas_update_Response_200"},"custom_fields.lead_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.lead_list_Response_200"},"custom_fields.lead_create_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.lead_create_Response_200"},"custom_fields.lead_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.lead_get_Response_200"},"custom_fields.lead_update_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.lead_update_Response_200"},"custom_fields.lead_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.lead_delete_Response_200"},"custom_fields.contact_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.contact_list_Response_200"},"custom_fields.contact_create_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.contact_create_Response_200"},"custom_fields.contact_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.contact_get_Response_200"},"custom_fields.contact_update_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.contact_update_Response_200"},"custom_fields.contact_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.contact_delete_Response_200"},"custom_fields.opportunity_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.opportunity_list_Response_200"},"custom_fields.opportunity_create_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.opportunity_create_Response_200"},"custom_fields.opportunity_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.opportunity_get_Response_200"},"custom_fields.opportunity_update_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.opportunity_update_Response_200"},"custom_fields.opportunity_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.opportunity_delete_Response_200"},"custom_fields.activity_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.activity_list_Response_200"},"custom_fields.activity_create_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.activity_create_Response_200"},"custom_fields.activity_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.activity_get_Response_200"},"custom_fields.activity_update_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.activity_update_Response_200"},"custom_fields.activity_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.activity_delete_Response_200"},"custom_fields.custom_object_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.custom_object_list_Response_200"},"custom_fields.custom_object_create_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.custom_object_create_Response_201"},"custom_fields.custom_object_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.custom_object_get_Response_200"},"custom_fields.custom_object_update_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.custom_object_update_Response_200"},"custom_fields.shared_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.shared_list_Response_200"},"custom_fields.shared_create_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.shared_create_Response_200"},"custom_fields.shared_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.shared_get_Response_200"},"custom_fields.shared_update_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.shared_update_Response_200"},"custom_fields.shared_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.shared_delete_Response_200"},"custom_fields.shared_createAssociation_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.shared_createAssociation_Response_201"},"custom_fields.shared_getAssociation_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.shared_getAssociation_Response_200"},"custom_fields.shared_updateAssociation_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_fields.shared_updateAssociation_Response_200"},"custom_activity_types_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_activity_types_list_Response_200"},"custom_activity_types_create_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"custom_activity_types_create_Response_201"},"custom_activity_types_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_activity_types_get_Response_200"},"custom_activity_types_update_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_activity_types_update_Response_200"},"custom_object_types_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_object_types_list_Response_200"},"custom_object_types_create_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"custom_object_types_create_Response_201"},"custom_object_types_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_object_types_get_Response_200"},"custom_object_types_update_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom_object_types_update_Response_200"},"PipelineOpportunityStatus":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"type":{"$ref":"#/components/schemas/OpportunityStatusType"}},"required":["id","label","type"],"title":"PipelineOpportunityStatus"},"Pipeline":{"type":"object","properties":{"created_by":{"type":["string","null"]},"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"id":{"type":"string"},"name":{"type":"string"},"organization_id":{"type":"string"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/PipelineOpportunityStatus"}},"updated_by":{"type":["string","null"]}},"required":["created_by","date_created","date_updated","id","name","organization_id","statuses","updated_by"],"title":"Pipeline"},"pipelines_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Pipeline"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"pipelines_list_Response_200"},"NewPipelineOpportunityStatus":{"type":"object","properties":{"label":{"type":"string","minLength":1},"type":{"$ref":"#/components/schemas/OpportunityStatusType"}},"required":["label"],"title":"NewPipelineOpportunityStatus"},"CreatePipeline":{"type":"object","properties":{"name":{"type":"string"},"statuses":{"type":["array","null"],"items":{"$ref":"#/components/schemas/NewPipelineOpportunityStatus"},"default":null,"description":"Opportunity Statuses to create within the new Pipeline."}},"required":["name"],"title":"CreatePipeline"},"ExistingPipelineOpportunityStatus":{"type":"object","properties":{"id":{"type":"string","description":"ID of an existing Opportunity Status. May belong to a different Pipeline, in which case the status is moved into this one."}},"required":["id"],"title":"ExistingPipelineOpportunityStatus"},"UpdatePipeline":{"type":"object","properties":{"name":{"type":"string","default":""},"statuses":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ExistingPipelineOpportunityStatus"},"default":null,"description":"Opportunity Statuses of this Pipeline, in the desired order."}},"title":"UpdatePipeline"},"OpportunityStatus":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"organization_id":{"type":"string"},"pipeline_id":{"type":"string"},"type":{"$ref":"#/components/schemas/OpportunityStatusType"}},"required":["id","label","organization_id","type"],"title":"OpportunityStatus"},"opportunity_statuses_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OpportunityStatus"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"opportunity_statuses_list_Response_200"},"CreateOpportunityStatus":{"type":"object","properties":{"label":{"type":"string","minLength":1},"pipeline_id":{"type":["string","null"],"default":null},"type":{"$ref":"#/components/schemas/OpportunityStatusType"}},"required":["label"],"title":"CreateOpportunityStatus"},"UpdateOpportunityStatus":{"type":"object","properties":{"label":{"type":"string","minLength":1},"pipeline_id":{"type":["string","null"],"default":null}},"required":["label"],"title":"UpdateOpportunityStatus"},"opportunity_statuses_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"opportunity_statuses_delete_Response_200"},"LeadStatusColor":{"type":"string","enum":["blue","gray","green","magenta","orange","purple","teal","yellow"],"title":"LeadStatusColor"},"LeadStatus":{"type":"object","properties":{"color":{"oneOf":[{"$ref":"#/components/schemas/LeadStatusColor"},{"type":"null"}]},"id":{"type":"string"},"label":{"type":"string"},"organization_id":{"type":"string"}},"required":["color","id","label","organization_id"],"title":"LeadStatus"},"lead_statuses_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LeadStatus"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"lead_statuses_list_Response_200"},"CreateOrUpdateLeadStatus":{"type":"object","properties":{"color":{"oneOf":[{"$ref":"#/components/schemas/LeadStatusColor"},{"type":"null"}]},"label":{"type":"string","minLength":1}},"required":["label"],"title":"CreateOrUpdateLeadStatus"},"lead_statuses_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"lead_statuses_delete_Response_200"},"IntegrationLinkType":{"type":"string","enum":["lead","contact","opportunity"],"title":"IntegrationLinkType"},"IntegrationLink":{"type":"object","properties":{"created_by":{"type":["string","null"]},"date_created":{"type":["string","null"],"format":"date-time"},"date_updated":{"type":["string","null"],"format":"date-time"},"id":{"type":"string"},"name":{"type":"string"},"organization_id":{"type":"string"},"type":{"$ref":"#/components/schemas/IntegrationLinkType"},"updated_by":{"type":["string","null"]},"url":{"type":"string"}},"required":["created_by","date_created","date_updated","id","name","organization_id","type","updated_by","url"],"title":"IntegrationLink"},"integration_links_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationLink"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"integration_links_list_Response_200"},"CreateIntegrationLink":{"type":"object","properties":{"name":{"type":"string"},"type":{"$ref":"#/components/schemas/IntegrationLinkType"},"url":{"type":"string"}},"required":["name","type","url"],"title":"CreateIntegrationLink"},"UpdateIntegrationLink":{"type":"object","properties":{"name":{"type":["string","null"],"default":null},"type":{"oneOf":[{"$ref":"#/components/schemas/IntegrationLinkType"},{"type":"null"}],"default":null},"url":{"type":["string","null"],"default":null}},"title":"UpdateIntegrationLink"},"integration_links_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"integration_links_delete_Response_200"},"FormFieldChoice":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"],"title":"FormFieldChoice"},"FormFieldDefinition":{"type":"object","properties":{"choices":{"type":["array","null"],"items":{"$ref":"#/components/schemas/FormFieldChoice"}},"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"required":["choices","id","name","type"],"title":"FormFieldDefinition"},"Form":{"type":"object","properties":{"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"field_definitions":{"type":"array","items":{"$ref":"#/components/schemas/FormFieldDefinition"}},"id":{"type":"string"},"is_archived":{"type":"boolean"},"name":{"type":"string"},"organization_id":{"type":"string"}},"required":["date_created","date_updated","field_definitions","id","is_archived","name","organization_id"],"title":"Form"},"forms_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Form"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"forms_list_Response_200"},"email_templates_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"email_templates_list_Response_200"},"email_templates_create_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"email_templates_create_Response_200"},"email_templates_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"email_templates_get_Response_200"},"email_templates_update_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"email_templates_update_Response_200"},"email_templates_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"email_templates_delete_Response_200"},"EmailTemplateIdRenderGetParametersBulkObjectType":{"type":"string","enum":["lead","contact"],"title":"EmailTemplateIdRenderGetParametersBulkObjectType"},"EmailTemplateIdRenderGetParametersContactPreference":{"type":"string","enum":["lead","contact","all"],"title":"EmailTemplateIdRenderGetParametersContactPreference"},"EmailTemplateIdRenderGetParametersSortSchemaItemsDirection":{"type":"string","enum":["asc","desc"],"title":"EmailTemplateIdRenderGetParametersSortSchemaItemsDirection"},"EmailTemplateIdRenderGetParametersSortSchemaItems":{"type":"object","properties":{"direction":{"$ref":"#/components/schemas/EmailTemplateIdRenderGetParametersSortSchemaItemsDirection"},"field":{"type":"string"}},"required":["direction","field"],"title":"EmailTemplateIdRenderGetParametersSortSchemaItems"},"EmailTemplateIdRenderGetParametersMode":{"type":"string","enum":["lead","contact"],"title":"EmailTemplateIdRenderGetParametersMode"},"email_templates_render_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"email_templates_render_Response_200"},"sms_templates_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"sms_templates_list_Response_200"},"CreateSMSTemplateAttachment":{"type":"object","properties":{"content_type":{"type":"string"},"filename":{"type":"string"},"url":{"type":"string"}},"required":["content_type","filename","url"],"title":"CreateSMSTemplateAttachment"},"CreateSMSTemplate":{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/CreateSMSTemplateAttachment"}},"is_shared":{"type":"boolean"},"name":{"type":"string"},"text":{"type":"string"}},"required":["name"],"title":"CreateSMSTemplate"},"sms_templates_create_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"sms_templates_create_Response_201"},"sms_templates_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"sms_templates_get_Response_200"},"UpdateSMSTemplateAttachment":{"type":"object","properties":{"content_type":{"type":"string"},"filename":{"type":"string"},"url":{"type":"string"}},"required":["content_type","filename","url"],"title":"UpdateSMSTemplateAttachment"},"SMSTemplateStatus":{"type":"string","enum":["active","archived"],"title":"SMSTemplateStatus"},"UpdateSMSTemplate":{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/UpdateSMSTemplateAttachment"}},"is_shared":{"type":"boolean"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/SMSTemplateStatus"},"text":{"type":"string"}},"title":"UpdateSMSTemplate"},"sms_templates_update_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"sms_templates_update_Response_200"},"OutcomeAppliesTo":{"type":"string","enum":["calls","meetings"],"title":"OutcomeAppliesTo"},"OutcomeType":{"type":"string","enum":["vm-dropped","custom"],"title":"OutcomeType"},"Outcome":{"type":"object","properties":{"applies_to":{"type":"array","items":{"$ref":"#/components/schemas/OutcomeAppliesTo"}},"created_by":{"type":["string","null"]},"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"description":{"type":["string","null"]},"id":{"type":"string"},"name":{"type":"string"},"organization_id":{"type":"string"},"type":{"$ref":"#/components/schemas/OutcomeType"},"updated_by":{"type":["string","null"]}},"required":["applies_to","created_by","date_created","date_updated","description","id","name","organization_id","type","updated_by"],"title":"Outcome"},"outcomes_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Outcome"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"outcomes_list_Response_200"},"CreateOutcome":{"type":"object","properties":{"applies_to":{"type":["array","null"],"items":{"$ref":"#/components/schemas/OutcomeAppliesTo"},"default":null,"description":"Deprecated. This field will be derived from `type` in a future update: `custom` applies to calls and meetings, `vm-dropped` applies to calls only.","deprecated":true},"description":{"type":["string","null"],"default":null,"description":"Explain what the outcome means and when it should be used."},"name":{"type":"string","description":"Displayed to users wherever outcomes can be selected."},"type":{"$ref":"#/components/schemas/OutcomeType","description":"Set to `vm-dropped` if this outcome should be automatically set on calls whenever a team member performs a Voicemail Drop. Otherwise, leave empty or explicitly set to `custom` (default)."}},"required":["name"],"title":"CreateOutcome"},"UpdateOutcome":{"type":"object","properties":{"applies_to":{"type":["array","null"],"items":{"$ref":"#/components/schemas/OutcomeAppliesTo"},"default":null,"description":"Deprecated. This field will be derived from `type` in a future update: `custom` applies to calls and meetings, `vm-dropped` applies to calls only.","deprecated":true},"description":{"type":["string","null"],"default":null,"description":"Explain what the outcome means and when it should be used."},"name":{"type":["string","null"],"default":null,"description":"Displayed to users wherever outcomes can be selected."},"type":{"oneOf":[{"$ref":"#/components/schemas/OutcomeType"},{"type":"null"}],"default":null,"description":"Set to `vm-dropped` if this outcome should be automatically set on calls whenever a team member performs a Voicemail Drop. Otherwise, leave empty or explicitly set to `custom` (default)."}},"title":"UpdateOutcome"},"outcomes_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"outcomes_delete_Response_200"},"Playbook":{"type":"object","properties":{"archived_at":{"type":["string","null"],"format":"date-time"},"archived_by_id":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"created_by_id":{"type":"string"},"custom_field_ids":{"type":"array","items":{"type":"string"}},"description":{"type":["string","null"]},"id":{"type":"string"},"name":{"type":"string"},"organization_id":{"type":"string"},"outcome_ids":{"type":"array","items":{"type":"string"}},"position":{"type":["integer","null"]},"summary_guidance":{"type":["string","null"]},"updated_at":{"type":"string","format":"date-time"},"updated_by_id":{"type":"string"}},"required":["archived_at","archived_by_id","created_at","created_by_id","custom_field_ids","description","id","name","organization_id","outcome_ids","position","summary_guidance","updated_at","updated_by_id"],"title":"Playbook"},"playbooks_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Playbook"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"playbooks_list_Response_200"},"CreatePlaybook":{"type":"object","properties":{"custom_field_ids":{"type":"array","items":{"type":"string"},"description":"IDs of [Shared Custom Fields](/api/resources/custom-fields/custom-fields-shared) to associate with this Playbook."},"description":{"type":["string","null"],"description":"Description of the playbook."},"name":{"type":"string"},"outcome_ids":{"type":"array","items":{"type":"string"},"description":"IDs of [Outcomes](/api/resources/outcomes/) that should be associated with this Playbook."},"summary_guidance":{"type":["string","null"],"description":"Guidance for AI summaries of calls and meetings associated with this Playbook."}},"required":["name"],"title":"CreatePlaybook"},"UpdatePlaybook":{"type":"object","properties":{"custom_field_ids":{"type":"array","items":{"type":"string"},"description":"IDs of [Shared Custom Fields](/api/resources/custom-fields/custom-fields-shared) to associate with this Playbook."},"description":{"type":["string","null"],"description":"Description of the playbook."},"name":{"type":"string"},"outcome_ids":{"type":"array","items":{"type":"string"},"description":"IDs of [Outcomes](/api/resources/outcomes/) that should be associated with this Playbook."},"summary_guidance":{"type":["string","null"],"description":"Guidance for AI summaries of calls and meetings associated with this Playbook."}},"title":"UpdatePlaybook"},"scheduling_links_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"scheduling_links_list_Response_200"},"scheduling_links_create_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"scheduling_links_create_Response_201"},"scheduling_links_createIntegration_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"scheduling_links_createIntegration_Response_200"},"scheduling_links_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"scheduling_links_get_Response_200"},"scheduling_links_update_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"scheduling_links_update_Response_200"},"scheduling_links_listShared_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"scheduling_links_listShared_Response_200"},"scheduling_links_createShared_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"scheduling_links_createShared_Response_201"},"scheduling_links_getShared_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"scheduling_links_getShared_Response_200"},"scheduling_links_updateShared_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"scheduling_links_updateShared_Response_200"},"scheduling_links_createSharedAssociation_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"scheduling_links_createSharedAssociation_Response_201"},"scheduling_links_deleteSharedAssociation_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"scheduling_links_deleteSharedAssociation_Response_200"},"connected_accounts_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"connected_accounts_list_Response_200"},"connected_accounts_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"connected_accounts_get_Response_200"},"send_as_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"send_as_list_Response_200"},"send_as_create_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"send_as_create_Response_201"},"send_as_bulkCreate_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"send_as_bulkCreate_Response_200"},"send_as_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"send_as_get_Response_200"},"unsubscribed_emails_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"unsubscribed_emails_list_Response_200"},"CreateUnsubscribedEmail":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":500}},"required":["email"],"title":"CreateUnsubscribedEmail"},"unsubscribed_emails_create_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"unsubscribed_emails_create_Response_201"},"unsubscribed_emails_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"unsubscribed_emails_delete_Response_200"},"UnderlyingCarrier":{"type":"string","enum":["twilio","plivo"],"title":"UnderlyingCarrier"},"CarrierNumberType":{"type":"string","enum":["local","national","mobile","tollfree","shortcode"],"title":"CarrierNumberType"},"PhoneNumberType":{"type":"string","enum":["internal","external","virtual"],"title":"PhoneNumberType"},"PhoneNumber":{"type":"object","properties":{"address_id":{"type":["string","null"]},"bundle_id":{"type":["string","null"]},"carrier":{"oneOf":[{"$ref":"#/components/schemas/UnderlyingCarrier"},{"type":"null"}]},"carrier_type":{"oneOf":[{"$ref":"#/components/schemas/CarrierNumberType"},{"type":"null"}]},"country":{"type":["string","null"]},"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"forward_to":{"type":["string","null"]},"forward_to_enabled":{"type":"boolean"},"forward_to_formatted":{"type":["string","null"]},"id":{"type":"string"},"inbound_ring_duration":{"type":["integer","null"],"description":"Number of seconds we ring this number on inbound calls before moving on (e.g. to voicemail). `null` means the default of 30 seconds is used."},"is_group_number":{"type":"boolean","description":"This field is deprecated and will be removed in a future update. Until then, it is set to `false` when the phone number has exactly one member (as defined by the `participants` field) and doesn't have any of the \"shared\" configuration set up (e.g. a phone menu, lead-based routing, a non-default ring order, etc.), and `true` otherwise.","deprecated":true},"is_premium":{"type":"boolean"},"is_verified":{"type":"boolean"},"label":{"type":"string"},"last_billed_price":{"type":["number","null"],"format":"double"},"mms_enabled":{"type":"boolean"},"next_billing_on":{"type":["string","null"],"format":"date-time"},"number":{"type":"string"},"number_formatted":{"type":"string"},"organization_id":{"type":"string"},"participants":{"type":"array","items":{"type":"string"},"description":"Every member of the phone number, as user IDs. If this field is absent, see `user_id` for the sole member."},"phone_numbers":{"type":"array","items":{"type":"string"},"description":"Present unless the phone number has exactly one member and no shared-number configuration (a phone menu, lead-based routing, a dial-out list, or a non-default ring order)."},"phone_numbers_formatted":{"type":"array","items":{"type":"string"},"description":"Present under the same condition as `phone_numbers`, with each value formatted for display."},"press_1_to_accept":{"type":"boolean"},"sms_enabled":{"type":"boolean"},"supports_mms_to_countries":{"type":"array","items":{"type":"string"}},"supports_sms_to_countries":{"type":"array","items":{"type":"string"}},"type":{"$ref":"#/components/schemas/PhoneNumberType"},"user_id":{"type":["string","null"],"description":"This field is deprecated. See the `participants` field instead to learn who's assigned to this phone number. This `user_id` field will be removed in a future update. Until then, it is set to a specific user ID *only if* the given phone number has a single participant and no additional \"shared\" configuration (e.g. a phone menu, lead-based routing, a non-default ring order, etc.).","deprecated":true},"voicemail_greeting_url":{"type":["string","null"]},"was_ported":{"type":"boolean"}},"required":["address_id","bundle_id","carrier","carrier_type","country","date_created","date_updated","id","is_group_number","is_premium","is_verified","label","last_billed_price","mms_enabled","next_billing_on","number","number_formatted","organization_id","sms_enabled","supports_mms_to_countries","supports_sms_to_countries","type","user_id"],"title":"PhoneNumber"},"phone_numbers_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"phone_numbers_list_Response_200"},"CreatePhoneNumberRequestCarrierType":{"type":"string","enum":["local","national","mobile","tollfree"],"title":"CreatePhoneNumberRequestCarrierType"},"PhoneNumberSharing":{"type":"string","enum":["personal","group"],"title":"PhoneNumberSharing"},"CreatePhoneNumberRequest":{"type":"object","properties":{"assign_to":{"type":["array","null"],"items":{"type":"string"},"default":null,"description":"IDs of the users the new phone number is assigned to. When omitted, the number is assigned to the user making the request. Assigning it to anyone else requires the \"Manage Team Phone Numbers\" permission, and every user must be an active member of the organization who is allowed to make calls."},"bundle_id":{"type":["string","null"],"default":null},"carrier_type":{"oneOf":[{"$ref":"#/components/schemas/CreatePhoneNumberRequestCarrierType"},{"type":"null"}],"default":null},"country":{"type":"string","description":"A two letter ISO country code (e.g. `US` for United States)."},"prefix":{"type":"string","maxLength":5,"default":"","description":"A string with the phone number prefix or area code, not including the country code."},"sharing":{"$ref":"#/components/schemas/PhoneNumberSharing","description":"Deprecated. `personal` for a number that belongs to an individual user, or `group` for a group number. The distinction between personal and group numbers is being removed, and this field will be removed in a future update. When omitted, defaults to `personal`.","deprecated":true},"with_mms":{"type":["boolean","null"],"default":null,"description":"By default, MMS-capable numbers are rented if Close supports MMS for the given country. Renting an MMS-capable number can be forced by setting this flag to `true`. If set to `false`, certain prefixes that don't support MMS can be rented in countries where Close supports MMS. In most scenarios, this flag should not be passed. When you request an MMS number, you must set `with_sms` to `true` as well."},"with_sms":{"type":["boolean","null"],"default":null,"description":"By default, SMS-capable numbers are rented if Close supports SMS for the given country. Renting an SMS-capable number can be forced by setting this flag to `true`. If set to `false`, certain prefixes that don't support SMS can be rented in countries where Close supports SMS. In most scenarios, this flag should not be passed unless a `has-voice-only` error status is received."}},"required":["country"],"title":"CreatePhoneNumberRequest"},"phone_numbers_create_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"phone_numbers_create_Response_201"},"UpdatePhoneNumber":{"type":"object","properties":{"forward_to":{"type":"string"},"forward_to_enabled":{"type":"boolean"},"inbound_ring_duration":{"type":"integer","minimum":15,"maximum":90,"description":"Number of seconds (15-90) to ring this number on inbound calls before moving on (e.g. to voicemail)."},"label":{"type":"string"},"participants":{"type":"array","items":{"type":"string"}},"phone_numbers":{"type":"array","items":{"type":"string"}},"press_1_to_accept":{"type":"boolean"},"voicemail_greeting_url":{"type":["string","null"]}},"title":"UpdatePhoneNumber"},"phone_numbers_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"phone_numbers_delete_Response_200"},"BlockedPhoneNumber":{"type":"object","properties":{"created_by":{"type":"string","description":"User who created this Blocked Number initially."},"date_created":{"type":"string","format":"date-time","description":"When this Blocked Number was created."},"date_updated":{"type":"string","format":"date-time","description":"When this Blocked Number was last updated."},"id":{"type":"string"},"organization_id":{"type":"string"},"phone":{"type":"string","description":"The phone number (in E.164 format) to block."},"reason":{"type":"string","description":"The reason for blocking the given phone number."},"updated_by":{"type":"string","description":"User who most recently updated this Blocked Number."}},"required":["created_by","date_created","date_updated","id","organization_id","phone","reason","updated_by"],"title":"BlockedPhoneNumber"},"blocked_phone_numbers_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BlockedPhoneNumber"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"blocked_phone_numbers_list_Response_200"},"CreateBlockedPhoneNumber":{"type":"object","properties":{"phone":{"type":"string","description":"The phone number (in E.164 format) that you wish to block."},"reason":{"type":"string","description":"The reason why you wish to block a given phone number."}},"required":["phone","reason"],"title":"CreateBlockedPhoneNumber"},"BlockedPhoneNumberSettings":{"type":"object","properties":{"reject_anonymous_inbound_calls":{"type":"boolean"}},"required":["reject_anonymous_inbound_calls"],"title":"BlockedPhoneNumberSettings"},"UpdateBlockedPhoneNumberSettings":{"type":"object","properties":{"reject_anonymous_inbound_calls":{"type":"boolean"}},"required":["reject_anonymous_inbound_calls"],"title":"UpdateBlockedPhoneNumberSettings"},"UpdateBlockedPhoneNumber":{"type":"object","properties":{"reason":{"type":"string","description":"The updated reason for blocking the given phone number."}},"required":["reason"],"title":"UpdateBlockedPhoneNumber"},"DialerGetParametersSourceTypeSchema":{"type":"string","enum":["saved-search","shared-entry"],"title":"DialerGetParametersSourceTypeSchema"},"dialers_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"dialers_list_Response_200"},"dialers_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"dialers_get_Response_200"},"users_getMe_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"users_getMe_Response_200"},"UserGetParametersOrderBy":{"type":"string","enum":["last_name,first_name","first_name,last_name"],"title":"UserGetParametersOrderBy"},"users_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"users_list_Response_200"},"users_listAvailabilities_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"users_listAvailabilities_Response_200"},"UserIdGetParametersOrderBy":{"type":"string","enum":["last_name,first_name","first_name,last_name"],"title":"UserIdGetParametersOrderBy"},"users_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"users_get_Response_200"},"organizations_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"organizations_get_Response_200"},"InlineLeadStatusPayload":{"type":"object","properties":{"id":{"type":"string","description":"ID of an existing lead status."},"label":{"type":"string","description":"Label of the lead status."}},"description":"Reference to an existing lead status by `id`.","title":"InlineLeadStatusPayload"},"Organization":{"type":"object","properties":{"currency":{"type":"string","description":"Default currency as a three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code."},"enable_unsubscribe_link":{"type":"boolean","description":"Enable the unsubscribe link by default in new email templates."},"lead_statuses":{"type":"array","items":{"$ref":"#/components/schemas/InlineLeadStatusPayload"},"description":"The organization's lead statuses. Provide the full list in the desired order to reorder them."},"name":{"type":"string","minLength":1,"description":"The organization's name."},"require_unsubscribe_link":{"type":"boolean","description":"Require an unsubscribe link in Bulk Emails and Workflows."}},"description":"Editable organization settings.","title":"Organization"},"organizations_update_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"organizations_update_Response_200"},"CreateMembership":{"type":"object","properties":{"email":{"type":"string","format":"email"},"role_id":{"type":"string","minLength":1,"description":"One of `superuser`, `user`, or `restricteduser` for the corresponding predefined role, or the ID of a custom [Role](https://developer.close.com/api/resources/roles). The role must not grant the `manage_organization` permission."}},"required":["email","role_id"],"title":"CreateMembership"},"AutoRecordCalls":{"type":"string","enum":["enabled","disabled","unset"],"title":"AutoRecordCalls"},"Permission":{"type":"string","enum":["manage_organization","manage_own_api_keys","manage_others_api_keys","manage_customizations","manage_group_numbers","manage_team_smart_views","manage_team_email_templates","manage_email_sequences","ai_enrich","bulk_import","bulk_email","bulk_enrich","bulk_sequence_subscriptions","bulk_edit","bulk_delete","export","merge_leads","delete_leads","manage_others_opportunities","delete_own_opportunities","manage_others_tasks","delete_own_tasks","view_voice_agents","manage_voice_agents","ai_chat","manage_chloe_call_tasks","view_custom_agents","manage_custom_agents","manage_others_activities","delete_own_activities","calling","call_coach_listen","call_coach_barge","view_all_leads","manage_web_forms"],"title":"Permission"},"TOTPAuthState":{"type":"string","enum":["enabled","disabled","blocked"],"title":"TOTPAuthState"},"MembershipUser":{"type":"object","properties":{"email":{"type":"string"},"first_name":{"type":["string","null"]},"full_name":{"type":["string","null"]},"google_profile_image_url":{"type":["string","null"]},"id":{"type":"string"},"image":{"type":["string","null"]},"last_name":{"type":["string","null"]},"totp_auth_state":{"$ref":"#/components/schemas/TOTPAuthState"}},"required":["email","first_name","full_name","google_profile_image_url","id","image","last_name","totp_auth_state"],"description":"A user nested in a membership response.","title":"MembershipUser"},"MembershipResponse":{"type":"object","properties":{"auto_record_calls":{"$ref":"#/components/schemas/AutoRecordCalls"},"default_caller_id":{"type":["string","null"]},"default_caller_id_mode":{"$ref":"#/components/schemas/CallerIdMode"},"hangup_recording_url":{"type":["string","null"]},"id":{"type":"string"},"may_workflows_impersonate":{"type":"boolean"},"onboarding_status":{"type":["string","null"]},"organization_id":{"type":"string"},"permissions_granted":{"type":"array","items":{"$ref":"#/components/schemas/Permission"}},"primary_personal_number":{"type":["string","null"]},"role":{"type":"string"},"role_id":{"type":"string"},"track_email_opens":{"type":"boolean"},"user":{"$ref":"#/components/schemas/MembershipUser"},"user_email":{"type":"string"},"user_first_name":{"type":["string","null"]},"user_full_name":{"type":["string","null"]},"user_google_profile_image_url":{"type":["string","null"]},"user_id":{"type":"string"},"user_image":{"type":["string","null"]},"user_last_name":{"type":["string","null"]},"user_phone":{"type":["string","null"],"description":"Phone number in E.164 format."},"user_phone_formatted":{"type":["string","null"]},"user_totp_auth_state":{"$ref":"#/components/schemas/TOTPAuthState"}},"required":["auto_record_calls","default_caller_id","default_caller_id_mode","hangup_recording_url","id","may_workflows_impersonate","onboarding_status","organization_id","primary_personal_number","role_id","track_email_opens","user_id"],"description":"An organization membership.","title":"MembershipResponse"},"Membership":{"type":"object","properties":{"auto_record_calls":{"$ref":"#/components/schemas/AutoRecordCalls","description":"Whether this member's calls are automatically recorded. Starts as `unset` and can be set to `enabled` or `disabled`."},"default_caller_id":{"type":["string","null"],"description":"ID of the phone number to use as this member's default outbound caller ID. Close keeps this value while `default_caller_id_mode` is `auto`, but outbound calls do not use it."},"default_caller_id_mode":{"$ref":"#/components/schemas/CallerIdMode","description":"How this member's outbound caller ID is chosen. In `fixed` mode, outbound calls use `default_caller_id`. In `auto` mode, Close derives the number for each call and ignores `default_caller_id`."},"hangup_recording_url":{"type":["string","null"],"description":"URL of the audio file used as this member's voicemail drop recording."},"may_workflows_impersonate":{"type":"boolean","description":"Whether Workflows may send emails on this member's behalf."},"role_id":{"type":"string","description":"One of `admin`, `superuser`, `user`, or `restricteduser` for the corresponding predefined role, or the ID of a custom [Role](https://developer.close.com/api/resources/roles)."},"track_email_opens":{"type":"boolean","description":"Whether email opens are tracked for emails this member sends."}},"description":"Editable settings for an organization membership.","title":"Membership"},"memberships_bulkUpdate_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"memberships_bulkUpdate_Response_200"},"memberships_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"memberships_delete_Response_200"},"memberships_getPinnedViews_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"memberships_getPinnedViews_Response_200"},"SetPinnedSavedView":{"type":"object","properties":{"saved_view_ids":{"type":"array","items":{"type":"string"}}},"required":["saved_view_ids"],"title":"SetPinnedSavedView"},"memberships_updatePinnedViews_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"memberships_updatePinnedViews_Response_200"},"roles_list_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"roles_list_Response_200"},"roles_create_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"roles_create_Response_201"},"roles_get_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"roles_get_Response_200"},"roles_update_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"roles_update_Response_200"},"roles_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"roles_delete_Response_200"},"GroupMember":{"type":"object","properties":{"user_id":{"type":"string"}},"required":["user_id"],"title":"GroupMember"},"Group":{"type":"object","properties":{"id":{"type":"string"},"members":{"type":["array","null"],"items":{"$ref":"#/components/schemas/GroupMember"},"default":null},"name":{"type":"string"},"organization_id":{"type":"string"}},"required":["id","name","organization_id"],"title":"Group"},"groups_list_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Group"}},"has_more":{"type":"boolean"}},"required":["data","has_more"],"title":"groups_list_Response_200"},"CreateGroup":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"title":"CreateGroup"},"CreateGroupMember":{"type":"object","properties":{"user_id":{"type":"string"}},"required":["user_id"],"title":"CreateGroupMember"}},"securitySchemes":{"ApiKeyAuth":{"type":"http","scheme":"basic","description":"Use your API key as the username and leave the password empty."},"OAuth2":{"type":"http","scheme":"bearer"}}}}