{ "opencollection": "1.0.0", "info": { "name": "API Endpoints", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_leads", "type": "folder" }, "items": [ { "info": { "name": "List Leads", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/lead/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "List Leads" }, { "info": { "name": "Create a new lead", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/lead/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 " }, { "info": { "name": "Merge two leads", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/lead/merge/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "For details and definitions of 'source' and 'destination', see the Merge Leads feature in the UI." }, { "info": { "name": "Get a single Lead", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/lead/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Get a single Lead" }, { "info": { "name": "Update an existing lead", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/lead/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete a lead", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/lead/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a lead" } ] }, { "info": { "name": "subpackage_contacts", "type": "folder" }, "items": [ { "info": { "name": "List contacts", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/contact/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." }, { "name": "lead_id", "value": "", "type": "query" } ] }, "docs": "List contacts" }, { "info": { "name": "Create a new contact", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/contact/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Fetch a single contact", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/contact/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Fetch a single contact" }, { "info": { "name": "Update an existing contact", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/contact/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a contact's information. If you're trying to update a custom field and that 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 contact." }, { "info": { "name": "Delete a contact", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/contact/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a contact" } ] }, { "info": { "name": "subpackage_opportunities", "type": "folder" }, "items": [ { "info": { "name": "List or filter opportunities", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/opportunity/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." }, { "name": "lead_id", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "user_id", "value": "", "type": "query" }, { "name": "user_id__in", "value": "", "type": "query" }, { "name": "status_id", "value": "", "type": "query" }, { "name": "status_id__in", "value": "", "type": "query" }, { "name": "status_type", "value": "", "type": "query" }, { "name": "status_type__in", "value": "", "type": "query" }, { "name": "status_label", "value": "", "type": "query" }, { "name": "status_label__in", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "status__in", "value": "", "type": "query" }, { "name": "date_won", "value": "", "type": "query" }, { "name": "date_won__gte", "value": "", "type": "query" }, { "name": "date_won__gt", "value": "", "type": "query" }, { "name": "date_won__lte", "value": "", "type": "query" }, { "name": "date_won__lt", "value": "", "type": "query" }, { "name": "date_created", "value": "", "type": "query" }, { "name": "date_created__gte", "value": "", "type": "query" }, { "name": "date_created__gt", "value": "", "type": "query" }, { "name": "date_created__lte", "value": "", "type": "query" }, { "name": "date_created__lt", "value": "", "type": "query" }, { "name": "date_updated", "value": "", "type": "query" }, { "name": "date_updated__gte", "value": "", "type": "query" }, { "name": "date_updated__gt", "value": "", "type": "query" }, { "name": "date_updated__lte", "value": "", "type": "query" }, { "name": "date_updated__lt", "value": "", "type": "query" }, { "name": "value_period", "value": "", "type": "query" }, { "name": "value_period__in", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query" }, { "name": "lead_query", "value": "", "type": "query" }, { "name": "lead_saved_search_id", "value": "", "type": "query" }, { "name": "is_stalled", "value": "", "type": "query" }, { "name": "_order_by", "value": "", "type": "query" }, { "name": "_group_by", "value": "", "type": "query" } ] }, "docs": "* 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 opport" }, { "info": { "name": "Create an opportunity", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/opportunity/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**lead_id** (optional): Opportunities belong to exactly one Lead. If you do not provide a `lead_id` then a new lead will be created (appearing as \"Untitled\" in the UI).\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 `a" }, { "info": { "name": "Retrieve an opportunity", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/opportunity/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Retrieve an opportunity" }, { "info": { "name": "Update an opportunity", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/opportunity/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "*status_id*\n\n- See description for `status_id` in `POST /opportunity/` above.\n- 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`.\n\n*date_won* (optional):\n\n- If not set on the resource or in the request, the `date_won` will be set automatically to today's date when setting `status_id` to a status" }, { "info": { "name": "Delete an opportunity", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/opportunity/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an opportunity" } ] }, { "info": { "name": "subpackage_tasks", "type": "folder" }, "items": [ { "info": { "name": "List or filter tasks", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/task/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "assigned_to", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__in", "value": "", "type": "query" }, { "name": "is_complete", "value": "", "type": "query" }, { "name": "lead_id", "value": "", "type": "query" }, { "name": "_order_by", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "_type", "value": "", "type": "query" }, { "name": "_type__in", "value": "", "type": "query" }, { "name": "view", "value": "", "type": "query" }, { "name": "date", "value": "", "type": "query" }, { "name": "date__lt", "value": "", "type": "query" }, { "name": "date__lte", "value": "", "type": "query" }, { "name": "date__gt", "value": "", "type": "query" }, { "name": "date__gte", "value": "", "type": "query" }, { "name": "due_date", "value": "", "type": "query" }, { "name": "due_date__lt", "value": "", "type": "query" }, { "name": "due_date__lte", "value": "", "type": "query" }, { "name": "due_date__gt", "value": "", "type": "query" }, { "name": "due_date__gte", "value": "", "type": "query" }, { "name": "date_created__lt", "value": "", "type": "query" }, { "name": "date_created__lte", "value": "", "type": "query" }, { "name": "date_created__gt", "value": "", "type": "query" }, { "name": "date_created__gte", "value": "", "type": "query" }, { "name": "date_updated__lt", "value": "", "type": "query" }, { "name": "date_updated__lte", "value": "", "type": "query" }, { "name": "date_updated__gt", "value": "", "type": "query" }, { "name": "date_updated__gte", "value": "", "type": "query" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "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 th" }, { "info": { "name": "Create a task", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/task/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Provide the type of task to be created in the `_type` field. Currently only tasks of type `lead` and `outgoing_call` can be created." }, { "info": { "name": "Bulk-update tasks", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/task/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "assigned_to", "value": "", "type": "query" }, { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__in", "value": "", "type": "query" }, { "name": "is_complete", "value": "", "type": "query" }, { "name": "lead_id", "value": "", "type": "query" }, { "name": "_order_by", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "_type", "value": "", "type": "query" }, { "name": "_type__in", "value": "", "type": "query" }, { "name": "view", "value": "", "type": "query" }, { "name": "date", "value": "", "type": "query" }, { "name": "date__lt", "value": "", "type": "query" }, { "name": "date__lte", "value": "", "type": "query" }, { "name": "date__gt", "value": "", "type": "query" }, { "name": "date__gte", "value": "", "type": "query" }, { "name": "due_date", "value": "", "type": "query" }, { "name": "due_date__lt", "value": "", "type": "query" }, { "name": "due_date__lte", "value": "", "type": "query" }, { "name": "due_date__gt", "value": "", "type": "query" }, { "name": "due_date__gte", "value": "", "type": "query" }, { "name": "date_created__lt", "value": "", "type": "query" }, { "name": "date_created__lte", "value": "", "type": "query" }, { "name": "date_created__gt", "value": "", "type": "query" }, { "name": "date_created__gte", "value": "", "type": "query" }, { "name": "date_updated__lt", "value": "", "type": "query" }, { "name": "date_updated__lte", "value": "", "type": "query" }, { "name": "date_updated__gt", "value": "", "type": "query" }, { "name": "date_updated__gte", "value": "", "type": "query" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Any of the filters of the GET endpoint may be used. For example, to update multiple tasks with given IDs A, B and C, `id__in=A,B,C` would be passed.\n\nOnly the `assigned_to`, `date` and `is_complete` fields may be updated." }, { "info": { "name": "Fetch a task's details", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/task/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Fetch a task's details" }, { "info": { "name": "Update a task", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/task/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete a task", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/task/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a task" } ] }, { "info": { "name": "subpackage_files", "type": "folder" }, "items": [ { "info": { "name": "Generate a signed S3 POST", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/files/upload/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get the data needed to make a request to S3 to store your file." } ] }, { "info": { "name": "subpackage_customObjects", "type": "folder" }, "items": [ { "info": { "name": "List Custom Object instances", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_object/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "lead_id", "value": "", "type": "query" }, { "name": "custom_object_type_id", "value": "", "type": "query" } ] }, "docs": "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 in" }, { "info": { "name": "Create a new Custom Object instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/custom_object/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Retrieve a single Custom Object instance", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_object/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve a single Custom Object instance" }, { "info": { "name": "Updating a Custom Object instance", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/custom_object/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "A Custom Object can be updated to add, change or remove any Custom Fields, and to change the `name` property." }, { "info": { "name": "Delete a Custom Object instance", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/custom_object/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a Custom Object instance" } ] }, { "info": { "name": "subpackage_comments", "type": "folder" }, "items": [ { "info": { "name": "Fetch multiple comments", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/comment/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "thread_id", "value": "", "type": "query" }, { "name": "object_id", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Create a Comment", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/comment/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Fetch an individual comment", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/comment/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Fetch an individual comment" }, { "info": { "name": "Update a Comment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/comment/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "You can use this endpoint to edit a comment body. Note that users may only update their own comments." }, { "info": { "name": "Remove a comment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/comment/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Fetch multiple comment threads", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/comment_thread/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "ids", "value": "", "type": "query" }, { "name": "object_ids", "value": "", "type": "query" } ] }, "docs": "Fetch multiple comment threads" }, { "info": { "name": "Fetch an individual comment thread", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/comment_thread/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Fetch an individual comment thread" } ] }, { "info": { "name": "subpackage_activities", "type": "folder" }, "items": [ { "info": { "name": "List or filter all activity types", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "id__in", "value": "", "type": "query", "description": "Filter by activity IDs (comma-separated)" }, { "name": "lead_id", "value": "", "type": "query", "description": "Filter by lead IDs (comma-separated)" }, { "name": "contact_id", "value": "", "type": "query", "description": "Filter by contact IDs (comma-separated)" }, { "name": "user_id", "value": "", "type": "query", "description": "Filter by user IDs (comma-separated)" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "_type", "value": "", "type": "query", "description": "Filter by activity type, e.g. Call (comma-separated)" }, { "name": "date_created__gte", "value": "", "type": "query" }, { "name": "date_created__lte", "value": "", "type": "query" }, { "name": "date_created__gt", "value": "", "type": "query" }, { "name": "date_created__lt", "value": "", "type": "query" }, { "name": "activity_at__gte", "value": "", "type": "query" }, { "name": "activity_at__lte", "value": "", "type": "query" }, { "name": "activity_at__gt", "value": "", "type": "query" }, { "name": "activity_at__lt", "value": "", "type": "query" }, { "name": "lead_id__in", "value": "", "type": "query" }, { "name": "user_id__in", "value": "", "type": "query" }, { "name": "contact_id__in", "value": "", "type": "query" }, { "name": "_type__in", "value": "", "type": "query" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." }, { "name": "_order_by", "value": "", "type": "query" } ] }, "docs": "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 a" } ] }, { "info": { "name": "subpackage_activitiesNotes", "type": "folder" }, "items": [ { "info": { "name": "List or filter all Note activities", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/note/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "id__in", "value": "", "type": "query", "description": "Filter by activity IDs (comma-separated)" }, { "name": "lead_id", "value": "", "type": "query", "description": "Filter by lead IDs (comma-separated)" }, { "name": "contact_id", "value": "", "type": "query", "description": "Filter by contact IDs (comma-separated)" }, { "name": "user_id", "value": "", "type": "query", "description": "Filter by user IDs (comma-separated)" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "_type", "value": "", "type": "query", "description": "Filter by activity type, e.g. Call (comma-separated)" }, { "name": "date_created__gte", "value": "", "type": "query" }, { "name": "date_created__lte", "value": "", "type": "query" }, { "name": "date_created__gt", "value": "", "type": "query" }, { "name": "date_created__lt", "value": "", "type": "query" }, { "name": "activity_at__gte", "value": "", "type": "query" }, { "name": "activity_at__lte", "value": "", "type": "query" }, { "name": "activity_at__gt", "value": "", "type": "query" }, { "name": "activity_at__lt", "value": "", "type": "query" } ] }, "docs": "List or filter all Note activities" }, { "info": { "name": "Create a Note activity", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/activity/note/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 `" }, { "info": { "name": "Get a single Note activity", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/note/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a single Note activity" }, { "info": { "name": "Update a Note activity", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/activity/note/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**`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`." }, { "info": { "name": "Delete a Note activity", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/activity/note/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a Note activity" } ] }, { "info": { "name": "subpackage_activitiesCalls", "type": "folder" }, "items": [ { "info": { "name": "List or filter all Call activities", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/call/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "id__in", "value": "", "type": "query", "description": "Filter by activity IDs (comma-separated)" }, { "name": "lead_id", "value": "", "type": "query", "description": "Filter by lead IDs (comma-separated)" }, { "name": "contact_id", "value": "", "type": "query", "description": "Filter by contact IDs (comma-separated)" }, { "name": "user_id", "value": "", "type": "query", "description": "Filter by user IDs (comma-separated)" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "_type", "value": "", "type": "query", "description": "Filter by activity type, e.g. Call (comma-separated)" }, { "name": "date_created__gte", "value": "", "type": "query" }, { "name": "date_created__lte", "value": "", "type": "query" }, { "name": "date_created__gt", "value": "", "type": "query" }, { "name": "date_created__lt", "value": "", "type": "query" }, { "name": "activity_at__gte", "value": "", "type": "query" }, { "name": "activity_at__lte", "value": "", "type": "query" }, { "name": "activity_at__gt", "value": "", "type": "query" }, { "name": "activity_at__lt", "value": "", "type": "query" } ] }, "docs": "List or filter all Call activities" }, { "info": { "name": "Log an external Call activity", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/activity/call/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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://)" }, { "info": { "name": "Get a single Call activity", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/call/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a single Call activity" }, { "info": { "name": "Update a Call activity", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/activity/call/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete a Call activity", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/activity/call/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a Call activity" } ] }, { "info": { "name": "subpackage_activitiesEmails", "type": "folder" }, "items": [ { "info": { "name": "List or filter all Email activities", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/email/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "id__in", "value": "", "type": "query", "description": "Filter by activity IDs (comma-separated)" }, { "name": "lead_id", "value": "", "type": "query", "description": "Filter by lead IDs (comma-separated)" }, { "name": "contact_id", "value": "", "type": "query", "description": "Filter by contact IDs (comma-separated)" }, { "name": "user_id", "value": "", "type": "query", "description": "Filter by user IDs (comma-separated)" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "_type", "value": "", "type": "query", "description": "Filter by activity type, e.g. Call (comma-separated)" }, { "name": "date_created__gte", "value": "", "type": "query" }, { "name": "date_created__lte", "value": "", "type": "query" }, { "name": "date_created__gt", "value": "", "type": "query" }, { "name": "date_created__lt", "value": "", "type": "query" }, { "name": "activity_at__gte", "value": "", "type": "query" }, { "name": "activity_at__lte", "value": "", "type": "query" }, { "name": "activity_at__gt", "value": "", "type": "query" }, { "name": "activity_at__lt", "value": "", "type": "query" } ] }, "docs": "You'll get one object per email message." }, { "info": { "name": "Create an Email activity", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/activity/email/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "*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 `sch" }, { "info": { "name": "Get a single Email activity", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/email/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a single Email activity" }, { "info": { "name": "Update an Email activity", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/activity/email/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete an Email activity", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/activity/email/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an Email activity" } ] }, { "info": { "name": "subpackage_activitiesEmailThreads", "type": "folder" }, "items": [ { "info": { "name": "List or filter all EmailThread activities", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/emailthread/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "id__in", "value": "", "type": "query", "description": "Filter by activity IDs (comma-separated)" }, { "name": "lead_id", "value": "", "type": "query", "description": "Filter by lead IDs (comma-separated)" }, { "name": "contact_id", "value": "", "type": "query", "description": "Filter by contact IDs (comma-separated)" }, { "name": "user_id", "value": "", "type": "query", "description": "Filter by user IDs (comma-separated)" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "_type", "value": "", "type": "query", "description": "Filter by activity type, e.g. Call (comma-separated)" }, { "name": "date_created__gte", "value": "", "type": "query" }, { "name": "date_created__lte", "value": "", "type": "query" }, { "name": "date_created__gt", "value": "", "type": "query" }, { "name": "date_created__lt", "value": "", "type": "query" }, { "name": "activity_at__gte", "value": "", "type": "query" }, { "name": "activity_at__lte", "value": "", "type": "query" }, { "name": "activity_at__gt", "value": "", "type": "query" }, { "name": "activity_at__lt", "value": "", "type": "query" } ] }, "docs": "You'll get one object per email conversation (generally grouped by subject)." }, { "info": { "name": "Get a single EmailThread activity", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/emailthread/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a single EmailThread activity" }, { "info": { "name": "Delete an EmailThread activity", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/activity/emailthread/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "This will also delete all the email activities belonging to this thread." } ] }, { "info": { "name": "subpackage_activitiesSms", "type": "folder" }, "items": [ { "info": { "name": "List or filter all SMS activities", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/sms/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "id__in", "value": "", "type": "query", "description": "Filter by activity IDs (comma-separated)" }, { "name": "lead_id", "value": "", "type": "query", "description": "Filter by lead IDs (comma-separated)" }, { "name": "contact_id", "value": "", "type": "query", "description": "Filter by contact IDs (comma-separated)" }, { "name": "user_id", "value": "", "type": "query", "description": "Filter by user IDs (comma-separated)" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "_type", "value": "", "type": "query", "description": "Filter by activity type, e.g. Call (comma-separated)" }, { "name": "date_created__gte", "value": "", "type": "query" }, { "name": "date_created__lte", "value": "", "type": "query" }, { "name": "date_created__gt", "value": "", "type": "query" }, { "name": "date_created__lt", "value": "", "type": "query" }, { "name": "activity_at__gte", "value": "", "type": "query" }, { "name": "activity_at__lte", "value": "", "type": "query" }, { "name": "activity_at__gt", "value": "", "type": "query" }, { "name": "activity_at__lt", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Create an SMS activity", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/activity/sms/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "send_to_inbox", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "*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 " }, { "info": { "name": "Get a single SMS activity", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/sms/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a single SMS activity" }, { "info": { "name": "Update an SMS activity", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/activity/sms/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete an SMS activity", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/activity/sms/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an SMS activity" } ] }, { "info": { "name": "subpackage_activitiesWhatsappMessages", "type": "folder" }, "items": [ { "info": { "name": "List or filter all WhatsAppMessage activities", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/whatsapp_message/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "id__in", "value": "", "type": "query", "description": "Filter by activity IDs (comma-separated)" }, { "name": "lead_id", "value": "", "type": "query", "description": "Filter by lead IDs (comma-separated)" }, { "name": "contact_id", "value": "", "type": "query", "description": "Filter by contact IDs (comma-separated)" }, { "name": "user_id", "value": "", "type": "query", "description": "Filter by user IDs (comma-separated)" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "_type", "value": "", "type": "query", "description": "Filter by activity type, e.g. Call (comma-separated)" }, { "name": "date_created__gte", "value": "", "type": "query" }, { "name": "date_created__lte", "value": "", "type": "query" }, { "name": "date_created__gt", "value": "", "type": "query" }, { "name": "date_created__lt", "value": "", "type": "query" }, { "name": "activity_at__gte", "value": "", "type": "query" }, { "name": "activity_at__lte", "value": "", "type": "query" }, { "name": "activity_at__gt", "value": "", "type": "query" }, { "name": "activity_at__lt", "value": "", "type": "query" }, { "name": "external_whatsapp_message_id", "value": "", "type": "query" } ] }, "docs": "Filter by `external_whatsapp_message_id` to find messages to update or delete based on changes in WhatsApp." }, { "info": { "name": "Create a WhatsAppMessage activity", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/activity/whatsapp_message/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "send_to_inbox", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "`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/" }, { "info": { "name": "Get a single WhatsAppMessage activity", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/whatsapp_message/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a single WhatsAppMessage activity" }, { "info": { "name": "Update a WhatsAppMessage activity", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/activity/whatsapp_message/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a WhatsAppMessage activity" }, { "info": { "name": "Delete a WhatsAppMessage activity", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/activity/whatsapp_message/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a WhatsAppMessage activity" } ] }, { "info": { "name": "subpackage_activitiesMeetings", "type": "folder" }, "items": [ { "info": { "name": "List or filter all Meeting activities", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/meeting/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "id__in", "value": "", "type": "query", "description": "Filter by activity IDs (comma-separated)" }, { "name": "lead_id", "value": "", "type": "query", "description": "Filter by lead IDs (comma-separated)" }, { "name": "contact_id", "value": "", "type": "query", "description": "Filter by contact IDs (comma-separated)" }, { "name": "user_id", "value": "", "type": "query", "description": "Filter by user IDs (comma-separated)" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "_type", "value": "", "type": "query", "description": "Filter by activity type, e.g. Call (comma-separated)" }, { "name": "date_created__gte", "value": "", "type": "query" }, { "name": "date_created__lte", "value": "", "type": "query" }, { "name": "date_created__gt", "value": "", "type": "query" }, { "name": "date_created__lt", "value": "", "type": "query" }, { "name": "activity_at__gte", "value": "", "type": "query" }, { "name": "activity_at__lte", "value": "", "type": "query" }, { "name": "activity_at__gt", "value": "", "type": "query" }, { "name": "activity_at__lt", "value": "", "type": "query" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "List or filter all Meeting activities" }, { "info": { "name": "Get a single Meeting activity", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/meeting/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "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\": \"conta" }, { "info": { "name": "Update a Meeting activity", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/activity/meeting/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Most commonly this can be used to update a meetings's `user_note_html` or `outcome_id`." }, { "info": { "name": "Delete a Meeting activity", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/activity/meeting/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a Meeting activity" }, { "info": { "name": "Create or update third-party Meeting integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/activity/meeting/:id/integration/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 JSO" } ] }, { "info": { "name": "subpackage_activitiesCustomActivities", "type": "folder" }, "items": [ { "info": { "name": "List or filter all Custom Activity instances", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/custom/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "id__in", "value": "", "type": "query", "description": "Filter by activity IDs (comma-separated)" }, { "name": "lead_id", "value": "", "type": "query", "description": "Filter by lead IDs (comma-separated)" }, { "name": "contact_id", "value": "", "type": "query", "description": "Filter by contact IDs (comma-separated)" }, { "name": "user_id", "value": "", "type": "query", "description": "Filter by user IDs (comma-separated)" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "_type", "value": "", "type": "query", "description": "Filter by activity type, e.g. Call (comma-separated)" }, { "name": "date_created__gte", "value": "", "type": "query" }, { "name": "date_created__lte", "value": "", "type": "query" }, { "name": "date_created__gt", "value": "", "type": "query" }, { "name": "date_created__lt", "value": "", "type": "query" }, { "name": "activity_at__gte", "value": "", "type": "query" }, { "name": "activity_at__lte", "value": "", "type": "query" }, { "name": "activity_at__gt", "value": "", "type": "query" }, { "name": "activity_at__lt", "value": "", "type": "query" }, { "name": "custom_activity_type_id", "value": "", "type": "query" }, { "name": "custom_activity_type_id__in", "value": "", "type": "query" } ] }, "docs": "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" }, { "info": { "name": "Create a new Custom Activity instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/activity/custom/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get a single Custom Activity instance", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/custom/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a single Custom Activity instance" }, { "info": { "name": "Updating a Custom Activity instance", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/activity/custom/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete a Custom Activity instance", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/activity/custom/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a Custom Activity instance" } ] }, { "info": { "name": "subpackage_activitiesCreations", "type": "folder" }, "items": [ { "info": { "name": "List or filter all Created activities", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/created/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "id__in", "value": "", "type": "query", "description": "Filter by activity IDs (comma-separated)" }, { "name": "lead_id", "value": "", "type": "query", "description": "Filter by lead IDs (comma-separated)" }, { "name": "contact_id", "value": "", "type": "query", "description": "Filter by contact IDs (comma-separated)" }, { "name": "user_id", "value": "", "type": "query", "description": "Filter by user IDs (comma-separated)" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "_type", "value": "", "type": "query", "description": "Filter by activity type, e.g. Call (comma-separated)" }, { "name": "date_created__gte", "value": "", "type": "query" }, { "name": "date_created__lte", "value": "", "type": "query" }, { "name": "date_created__gt", "value": "", "type": "query" }, { "name": "date_created__lt", "value": "", "type": "query" }, { "name": "activity_at__gte", "value": "", "type": "query" }, { "name": "activity_at__lte", "value": "", "type": "query" }, { "name": "activity_at__gt", "value": "", "type": "query" }, { "name": "activity_at__lt", "value": "", "type": "query" } ] }, "docs": "List or filter all Created activities" }, { "info": { "name": "Get a single Created activity", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/created/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a single Created activity" } ] }, { "info": { "name": "subpackage_activitiesFormSubmissions", "type": "folder" }, "items": [ { "info": { "name": "List or filter all FormSubmission activities", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/form_submission/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "id__in", "value": "", "type": "query", "description": "Filter by activity IDs (comma-separated)" }, { "name": "lead_id", "value": "", "type": "query", "description": "Filter by lead IDs (comma-separated)" }, { "name": "contact_id", "value": "", "type": "query", "description": "Filter by contact IDs (comma-separated)" }, { "name": "user_id", "value": "", "type": "query", "description": "Filter by user IDs (comma-separated)" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "_type", "value": "", "type": "query", "description": "Filter by activity type, e.g. Call (comma-separated)" }, { "name": "date_created__gte", "value": "", "type": "query" }, { "name": "date_created__lte", "value": "", "type": "query" }, { "name": "date_created__gt", "value": "", "type": "query" }, { "name": "date_created__lt", "value": "", "type": "query" }, { "name": "activity_at__gte", "value": "", "type": "query" }, { "name": "activity_at__lte", "value": "", "type": "query" }, { "name": "activity_at__gt", "value": "", "type": "query" }, { "name": "activity_at__lt", "value": "", "type": "query" }, { "name": "lead_id__in", "value": "", "type": "query" }, { "name": "user_id__in", "value": "", "type": "query" }, { "name": "contact_id__in", "value": "", "type": "query" }, { "name": "_type__in", "value": "", "type": "query" }, { "name": "form_id", "value": "", "type": "query", "description": "Filter by a specific form ID." }, { "name": "form_id__in", "value": "", "type": "query", "description": "Filter by multiple form IDs (comma-separated)." }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "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." }, { "info": { "name": "Get a single FormSubmission activity", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/form_submission/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Get a single FormSubmission activity" }, { "info": { "name": "Delete a FormSubmission activity", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/activity/form_submission/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a FormSubmission activity" } ] }, { "info": { "name": "subpackage_activitiesLeadStatusChanges", "type": "folder" }, "items": [ { "info": { "name": "List or filter all LeadStatusChange activities", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/status_change/lead/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "id__in", "value": "", "type": "query", "description": "Filter by activity IDs (comma-separated)" }, { "name": "lead_id", "value": "", "type": "query", "description": "Filter by lead IDs (comma-separated)" }, { "name": "contact_id", "value": "", "type": "query", "description": "Filter by contact IDs (comma-separated)" }, { "name": "user_id", "value": "", "type": "query", "description": "Filter by user IDs (comma-separated)" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "_type", "value": "", "type": "query", "description": "Filter by activity type, e.g. Call (comma-separated)" }, { "name": "date_created__gte", "value": "", "type": "query" }, { "name": "date_created__lte", "value": "", "type": "query" }, { "name": "date_created__gt", "value": "", "type": "query" }, { "name": "date_created__lt", "value": "", "type": "query" }, { "name": "activity_at__gte", "value": "", "type": "query" }, { "name": "activity_at__lte", "value": "", "type": "query" }, { "name": "activity_at__gt", "value": "", "type": "query" }, { "name": "activity_at__lt", "value": "", "type": "query" } ] }, "docs": "List or filter all LeadStatusChange activities" }, { "info": { "name": "Create a new LeadStatusChange activity", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/activity/status_change/lead/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get a single LeadStatusChange activity", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/status_change/lead/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a single LeadStatusChange activity" }, { "info": { "name": "Delete a single LeadStatusChange activity", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/activity/status_change/lead/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "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." } ] }, { "info": { "name": "subpackage_activitiesOpportunityStatusChanges", "type": "folder" }, "items": [ { "info": { "name": "List or filter all OpportunityStatusChange activities", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/status_change/opportunity/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "id__in", "value": "", "type": "query", "description": "Filter by activity IDs (comma-separated)" }, { "name": "lead_id", "value": "", "type": "query", "description": "Filter by lead IDs (comma-separated)" }, { "name": "contact_id", "value": "", "type": "query", "description": "Filter by contact IDs (comma-separated)" }, { "name": "user_id", "value": "", "type": "query", "description": "Filter by user IDs (comma-separated)" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "_type", "value": "", "type": "query", "description": "Filter by activity type, e.g. Call (comma-separated)" }, { "name": "date_created__gte", "value": "", "type": "query" }, { "name": "date_created__lte", "value": "", "type": "query" }, { "name": "date_created__gt", "value": "", "type": "query" }, { "name": "date_created__lt", "value": "", "type": "query" }, { "name": "activity_at__gte", "value": "", "type": "query" }, { "name": "activity_at__lte", "value": "", "type": "query" }, { "name": "activity_at__gt", "value": "", "type": "query" }, { "name": "activity_at__lt", "value": "", "type": "query" }, { "name": "opportunity_id", "value": "", "type": "query" } ] }, "docs": "List or filter all OpportunityStatusChange activities" }, { "info": { "name": "Create a new OpportunityStatusChange activity", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/activity/status_change/opportunity/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get a single OpportunityStatusChange activity", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/status_change/opportunity/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a single OpportunityStatusChange activity" }, { "info": { "name": "Delete a single OpportunityStatusChange activity", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/activity/status_change/opportunity/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "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." } ] }, { "info": { "name": "subpackage_activitiesLeadMerges", "type": "folder" }, "items": [ { "info": { "name": "List or filter all LeadMerge activities", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/lead_merge/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "id__in", "value": "", "type": "query", "description": "Filter by activity IDs (comma-separated)" }, { "name": "lead_id", "value": "", "type": "query", "description": "Filter by lead IDs (comma-separated)" }, { "name": "contact_id", "value": "", "type": "query", "description": "Filter by contact IDs (comma-separated)" }, { "name": "user_id", "value": "", "type": "query", "description": "Filter by user IDs (comma-separated)" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "_type", "value": "", "type": "query", "description": "Filter by activity type, e.g. Call (comma-separated)" }, { "name": "date_created__gte", "value": "", "type": "query" }, { "name": "date_created__lte", "value": "", "type": "query" }, { "name": "date_created__gt", "value": "", "type": "query" }, { "name": "date_created__lt", "value": "", "type": "query" }, { "name": "activity_at__gte", "value": "", "type": "query" }, { "name": "activity_at__lte", "value": "", "type": "query" }, { "name": "activity_at__gt", "value": "", "type": "query" }, { "name": "activity_at__lt", "value": "", "type": "query" } ] }, "docs": "List or filter all LeadMerge activities" }, { "info": { "name": "Get a single LeadMerge activity", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/lead_merge/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a single LeadMerge activity" } ] }, { "info": { "name": "subpackage_activitiesTaskCompletions", "type": "folder" }, "items": [ { "info": { "name": "List or filter all TaskCompleted activities", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/task_completed/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "id__in", "value": "", "type": "query", "description": "Filter by activity IDs (comma-separated)" }, { "name": "lead_id", "value": "", "type": "query", "description": "Filter by lead IDs (comma-separated)" }, { "name": "contact_id", "value": "", "type": "query", "description": "Filter by contact IDs (comma-separated)" }, { "name": "user_id", "value": "", "type": "query", "description": "Filter by user IDs (comma-separated)" }, { "name": "organization_id", "value": "", "type": "query" }, { "name": "_type", "value": "", "type": "query", "description": "Filter by activity type, e.g. Call (comma-separated)" }, { "name": "date_created__gte", "value": "", "type": "query" }, { "name": "date_created__lte", "value": "", "type": "query" }, { "name": "date_created__gt", "value": "", "type": "query" }, { "name": "date_created__lt", "value": "", "type": "query" }, { "name": "activity_at__gte", "value": "", "type": "query" }, { "name": "activity_at__lte", "value": "", "type": "query" }, { "name": "activity_at__gt", "value": "", "type": "query" }, { "name": "activity_at__lt", "value": "", "type": "query" } ] }, "docs": "List or filter all TaskCompleted activities" }, { "info": { "name": "Get a single TaskCompleted activity", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/activity/task_completed/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a single TaskCompleted activity" }, { "info": { "name": "Delete a TaskCompleted activity", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/activity/task_completed/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a TaskCompleted activity" } ] }, { "info": { "name": "subpackage_webhooks", "type": "folder" }, "items": [ { "info": { "name": "List Webhook subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/webhook/", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "List all webhook subscriptions for the organization." }, { "info": { "name": "Create new Webhook subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/webhook/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The subscription will send events to the specified URL.\n\nParameters:\n - `url` - Destination URL for the webhook subscription\n - `events` - 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 Webhoo" }, { "info": { "name": "Retrieve a single Webhook subscription", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/webhook/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "The response contains the subscription details." }, { "info": { "name": "Update existing Webhook subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/webhook/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "All parameters are optional. Only the parameters that are provided will be updated.\n\nParameters:\n - `url` - Destination URL for the webhook subscription\n - `events` - 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 " }, { "info": { "name": "Delete Webhook subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/webhook/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete Webhook subscription" } ] }, { "info": { "name": "subpackage_events", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of events", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/event/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "object_type", "value": "", "type": "query" }, { "name": "object_id", "value": "", "type": "query" }, { "name": "lead_id", "value": "", "type": "query" }, { "name": "action", "value": "", "type": "query" }, { "name": "user_id", "value": "", "type": "query" }, { "name": "date_updated__gt", "value": "", "type": "query" }, { "name": "date_updated__gte", "value": "", "type": "query" }, { "name": "date_updated__lt", "value": "", "type": "query" }, { "name": "date_updated__lte", "value": "", "type": "query" } ] }, "docs": "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 " }, { "info": { "name": "Retrieve a single event by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/event/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "The response contains a dictionary with a single event, using the format outlined in “Event format”." } ] }, { "info": { "name": "subpackage_smartViews", "type": "folder" }, "items": [ { "info": { "name": "List Smart Views", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/saved_search/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "type", "value": "", "type": "query" }, { "name": "type__in", "value": "", "type": "query" } ] }, "docs": "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`." }, { "info": { "name": "Create a Smart View", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/saved_search/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get a single Smart View", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/saved_search/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a single Smart View" }, { "info": { "name": "Update a Smart View", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/saved_search/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Smart View" }, { "info": { "name": "Delete a Smart View", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/saved_search/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a Smart View" } ] }, { "info": { "name": "subpackage_reporting", "type": "folder" }, "items": [ { "info": { "name": "Get an activity report", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/report/activity/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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-" }, { "info": { "name": "List the predefined metrics used in activity reports", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/report/activity/metrics/", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "List available metrics that can be used in activity reports." }, { "info": { "name": "Get custom report (Explorer)", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/report/custom/:org_id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "query", "value": "", "type": "query" }, { "name": "x", "value": "", "type": "query" }, { "name": "y", "value": "", "type": "query" }, { "name": "group_by", "value": "", "type": "query" }, { "name": "transform_y", "value": "", "type": "query" }, { "name": "interval", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" } ] }, "docs": "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" }, { "info": { "name": "Get a funnel report (stages)", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/report/funnel/opportunity/stages/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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-we" }, { "info": { "name": "Get a funnel report (totals)", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/report/funnel/opportunity/totals/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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-we" }, { "info": { "name": "Get sent emails report", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/report/sent_emails/:org_id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "date_start", "value": "", "type": "query" }, { "name": "date_end", "value": "", "type": "query" }, { "name": "user_id", "value": "", "type": "query" } ] }, "docs": "Get sent emails report" }, { "info": { "name": "Get lead status change report", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/report/statuses/lead/:org_id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "date_start", "value": "", "type": "query" }, { "name": "date_end", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query" }, { "name": "smart_view_id", "value": "", "type": "query" } ] }, "docs": "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 stat" }, { "info": { "name": "Get opportunity status change report", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/report/statuses/opportunity/:org_id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "date_start", "value": "", "type": "query" }, { "name": "date_end", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query" }, { "name": "smart_view_id", "value": "", "type": "query" }, { "name": "user_id", "value": "", "type": "query" } ] }, "docs": "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`" } ] }, { "info": { "name": "subpackage_sequences", "type": "folder" }, "items": [ { "info": { "name": "List Sequences", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/sequence/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." } ] }, "docs": "List Sequences" }, { "info": { "name": "Create a Sequence", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/sequence/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Sequence" }, { "info": { "name": "Fetch a Sequence", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/sequence/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." } ] }, "docs": "Fetch a Sequence" }, { "info": { "name": "Update a Sequence", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/sequence/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**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." }, { "info": { "name": "Delete a Sequence", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/sequence/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a Sequence" }, { "info": { "name": "List Sequence Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/sequence_subscription/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "contact_id", "value": "", "type": "query" }, { "name": "lead_id", "value": "", "type": "query" }, { "name": "sequence_id", "value": "", "type": "query" } ] }, "docs": "At least one of `sequence_id`, `contact_id`, and `lead_id` is required." }, { "info": { "name": "Subscribe a Contact to a Sequence", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/sequence_subscription/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Subscribe a Contact to a Sequence" }, { "info": { "name": "Fetch a single Sequence Subscription", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/sequence_subscription/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Fetch a single Sequence Subscription" }, { "info": { "name": "Update a specific Subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/sequence_subscription/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific Subscription" } ] }, { "info": { "name": "subpackage_bulkActionsEmail", "type": "folder" }, "items": [ { "info": { "name": "List bulk emails", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/bulk_action/email/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." }, { "name": "template_id", "value": "", "type": "query" } ] }, "docs": "List bulk emails" }, { "info": { "name": "Initiate a new bulk email", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/bulk_action/email/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "`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)." }, { "info": { "name": "Fetch a single bulk email object", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/bulk_action/email/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Fetch a single bulk email object" } ] }, { "info": { "name": "subpackage_bulkActionsEdit", "type": "folder" }, "items": [ { "info": { "name": "List bulk edits", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/bulk_action/edit/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "List bulk edits" }, { "info": { "name": "Initiate a new bulk edit", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/bulk_action/edit/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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` o" }, { "info": { "name": "Fetch a single bulk edit object", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/bulk_action/edit/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Fetch a single bulk edit object" } ] }, { "info": { "name": "subpackage_bulkActionsDelete", "type": "folder" }, "items": [ { "info": { "name": "List bulk deletes", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/bulk_action/delete/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "List bulk deletes" }, { "info": { "name": "Initiate a new bulk delete", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/bulk_action/delete/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use `\"send_done_email\": false` if you don't want to get a confirmation email after the bulk action is done." }, { "info": { "name": "Fetch a single bulk delete object", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/bulk_action/delete/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Fetch a single bulk delete object" } ] }, { "info": { "name": "subpackage_bulkActionsSequenceSubscriptions", "type": "folder" }, "items": [ { "info": { "name": "List bulk sequence subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/bulk_action/sequence_subscription/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "List bulk sequence subscriptions" }, { "info": { "name": "Initiate a new bulk sequence subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/bulk_action/sequence_subscription/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "`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 sequenc" }, { "info": { "name": "Fetch a single bulk sequence subscription object", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/bulk_action/sequence_subscription/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Fetch a single bulk sequence subscription object" } ] }, { "info": { "name": "subpackage_exports", "type": "folder" }, "items": [ { "info": { "name": "List all the exports", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/export/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "List all the exports" }, { "info": { "name": "Export leads based on a search query", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/export/lead/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 u" }, { "info": { "name": "Export opportunities, based on opportunity filters", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/export/opportunity/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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]±[" }, { "info": { "name": "Get a single Export", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/export/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "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`." } ] }, { "info": { "name": "subpackage_fieldEnrichment", "type": "folder" }, "items": [ { "info": { "name": "Enrich a specific field on a lead or contact using AI", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/enrich_field/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" } ] }, { "info": { "name": "subpackage_customFieldSchemas", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a custom field schema", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_field_schema/:object_type/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "object_type", "value": "", "type": "path" } ] }, "docs": "Retrieve a custom field schema" }, { "info": { "name": "Update a custom field schema", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/custom_field_schema/:object_type/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "object_type", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 giv" } ] }, { "info": { "name": "subpackage_customFieldsLead", "type": "folder" }, "items": [ { "info": { "name": "List Lead Custom Fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_field/lead/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "List all the lead custom fields for your organization." }, { "info": { "name": "Create a new Lead Custom Field", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/custom_field/lead/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Lead Custom Field" }, { "info": { "name": "Fetch Lead Custom Field's details", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_field/lead/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Fetch Lead Custom Field's details" }, { "info": { "name": "Update a Lead Custom Field", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/custom_field/lead/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 a" }, { "info": { "name": "Delete a Lead Custom Field", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/custom_field/lead/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a lead custom field. The field will immediately disappear from API responses and values on existing leads will be permanently removed." } ] }, { "info": { "name": "subpackage_customFieldsContact", "type": "folder" }, "items": [ { "info": { "name": "List Contact Custom Fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_field/contact/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "List all the contact custom fields for your organization." }, { "info": { "name": "Create a new Contact Custom Field", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/custom_field/contact/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Contact Custom Field" }, { "info": { "name": "Fetch Contact Custom Field's details", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_field/contact/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Fetch Contact Custom Field's details" }, { "info": { "name": "Update a Contact Custom Field", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/custom_field/contact/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 includ" }, { "info": { "name": "Delete a Contact Custom Field", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/custom_field/contact/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a contact custom field. The field will immediately disappear from API responses and values on existing contacts will be permanently removed." } ] }, { "info": { "name": "subpackage_customFieldsOpportunity", "type": "folder" }, "items": [ { "info": { "name": "List Opportunity Custom Fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_field/opportunity/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "List all the opportunity custom fields for your organization." }, { "info": { "name": "Create a new Opportunity Custom Field", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/custom_field/opportunity/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Opportunity Custom Field" }, { "info": { "name": "Fetch Opportunity Custom Field's details", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_field/opportunity/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Fetch Opportunity Custom Field's details" }, { "info": { "name": "Update an Opportunity Custom Field", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/custom_field/opportunity/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 includ" }, { "info": { "name": "Delete an Opportunity Custom Field", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/custom_field/opportunity/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an opportunity custom field. The field will immediately disappear from API responses and values on existing opportunities will be permanently removed." } ] }, { "info": { "name": "subpackage_customFieldsActivity", "type": "folder" }, "items": [ { "info": { "name": "List Activity Custom Fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_field/activity/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "List all the activity custom fields for your organization." }, { "info": { "name": "Create a new Activity Custom Field", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/custom_field/activity/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Fetch Activity Custom Field's details", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_field/activity/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Fetch Activity Custom Field's details" }, { "info": { "name": "Update an Activity Custom Field", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/custom_field/activity/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete an Activity Custom Field", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/custom_field/activity/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an activity custom field. The field will immediately disappear from API responses and values on existing activities will be permanently removed." } ] }, { "info": { "name": "subpackage_customFieldsCustomObject", "type": "folder" }, "items": [ { "info": { "name": "List Custom Object Custom Fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_field/custom_object_type/", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "List all the custom object custom fields for your organization." }, { "info": { "name": "Create a new Custom Object Custom Field", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/custom_field/custom_object_type/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Fetch Custom Object Custom Field's details", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_field/custom_object_type/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Fetch Custom Object Custom Field's details" }, { "info": { "name": "Update a Custom Object Custom Field", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/custom_field/custom_object_type/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete a Custom Object Custom Field", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/custom_field/custom_object_type/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "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." } ] }, { "info": { "name": "subpackage_customFieldsShared", "type": "folder" }, "items": [ { "info": { "name": "List Shared Custom Fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_field/shared/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "List all the shared custom fields for your organization." }, { "info": { "name": "Create a new Shared Custom Field", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/custom_field/shared/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Shared Custom Field" }, { "info": { "name": "Fetch Shared Custom Field's details", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_field/shared/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Fetch Shared Custom Field's details" }, { "info": { "name": "Update a Shared Custom Field", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/custom_field/shared/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete a Shared Custom Field", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/custom_field/shared/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Associate a Shared Custom Field with an object type", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/custom_field/shared/:scf_id/association/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "scf_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Fetch a Shared Custom Field Association", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_field/shared/:scf_id/association/:object_type/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "scf_id", "value": "", "type": "path" }, { "name": "object_type", "value": "", "type": "path" } ] }, "docs": "Fetch a Shared Custom Field Association" }, { "info": { "name": "Update an existing Shared Custom Field Association", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/custom_field/shared/:scf_id/association/:object_type/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "scf_id", "value": "", "type": "path" }, { "name": "object_type", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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/` when editing the association with a specific\n Custom Activity Type.\n- `custom_object_type/` when ed" }, { "info": { "name": "Disassociate a Shared Custom Field from an object type", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/custom_field/shared/:scf_id/association/:object_type/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "scf_id", "value": "", "type": "path" }, { "name": "object_type", "value": "", "type": "path" } ] }, "docs": "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/`, or `custom_object_type/`.\n\nIf the field was `required` on the associated type, removing the association also removes that requirement." } ] }, { "info": { "name": "subpackage_customActivityTypes", "type": "folder" }, "items": [ { "info": { "name": "List Custom Activity Types", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_activity/", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "List all custom activity types defined in the organization. The response includes all Custom Activity Types, including their Custom Field metadata." }, { "info": { "name": "Create new Custom Activity Type", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/custom_activity/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The type must be created before activity custom fields can be added." }, { "info": { "name": "Retrieve a single Custom Activity Type", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_activity/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "The response contains the Custom Activity Type including most Custom Field metadata." }, { "info": { "name": "Update existing Custom Activity Type", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/custom_activity/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete a Custom Activity Type", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/custom_activity/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a Custom Activity Type" } ] }, { "info": { "name": "subpackage_customObjectTypes", "type": "folder" }, "items": [ { "info": { "name": "List Custom Object Types", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_object_type/", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "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." }, { "info": { "name": "Create new Custom Object Type", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/custom_object_type/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 o" }, { "info": { "name": "Retrieve a single Custom Object Type", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/custom_object_type/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve a single custom object type by ID. The response contains the Custom Object Type including most Custom Field metadata." }, { "info": { "name": "Update existing Custom Object Type", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/custom_object_type/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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/cus" }, { "info": { "name": "Delete a Custom Object Type", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/custom_object_type/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a Custom Object Type" } ] }, { "info": { "name": "subpackage_pipelines", "type": "folder" }, "items": [ { "info": { "name": "List Pipelines for your organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/pipeline/", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "List Pipelines for your organization" }, { "info": { "name": "Create a Pipeline", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/pipeline/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Pipeline" }, { "info": { "name": "Update a Pipeline", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/pipeline/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete a Pipeline", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/pipeline/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Deletion is only allowed if the Pipeline doesn't contain any Opportunity Statuses. Delete all statuses first or move them to another pipeline." } ] }, { "info": { "name": "subpackage_opportunityStatuses", "type": "folder" }, "items": [ { "info": { "name": "List opportunity statuses for your organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/status/opportunity/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "List opportunity statuses for your organization" }, { "info": { "name": "Create an opportunity status", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/status/opportunity/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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`." }, { "info": { "name": "Rename an opportunity status", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/status/opportunity/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Rename an opportunity status" }, { "info": { "name": "Delete an opportunity status", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/status/opportunity/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "You should make sure no opportunities are assigned this status, first." } ] }, { "info": { "name": "subpackage_leadStatuses", "type": "folder" }, "items": [ { "info": { "name": "List lead statuses for your organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/status/lead/", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "List lead statuses for your organization" }, { "info": { "name": "Create a new status that can be applied to leads", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/status/lead/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new status that can be applied to leads" }, { "info": { "name": "Rename a lead status", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/status/lead/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a lead status. The `label` and `color` can be changed. To update the status of a particular lead, see PUT `/lead/{lead_id}/`." }, { "info": { "name": "Delete a lead status", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/status/lead/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "You should make sure no leads are assigned this status, first." } ] }, { "info": { "name": "subpackage_integrationLinks", "type": "folder" }, "items": [ { "info": { "name": "Get all integration links for your organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/integration_link/", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "Get all integration links for your organization" }, { "info": { "name": "Create an integration link", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/integration_link/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an integration link" }, { "info": { "name": "Get a single integration link", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/integration_link/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a single integration link" }, { "info": { "name": "Update an integration link", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/integration_link/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an integration link" }, { "info": { "name": "Delete an integration link", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/integration_link/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an integration link" } ] }, { "info": { "name": "subpackage_emailTemplates", "type": "folder" }, "items": [ { "info": { "name": "List email templates", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/email_template/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "is_archived", "value": "", "type": "query" }, { "name": "is_shared", "value": "", "type": "query" } ] }, "docs": "List email templates" }, { "info": { "name": "Create an email template", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/email_template/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an email template" }, { "info": { "name": "Fetch an email template", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/email_template/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." }, { "name": "include_embedded", "value": "", "type": "query", "description": "Include embedded templates used by Workflows." } ] }, "docs": "Fetch an email template" }, { "info": { "name": "Update an email template", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/email_template/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an email template" }, { "info": { "name": "Delete an email template", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/email_template/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an email template" }, { "info": { "name": "Render an email template", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/email_template/:id/render/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "email_account_id", "value": "", "type": "query" }, { "name": "bulk_object_type", "value": "", "type": "query" }, { "name": "contact_id", "value": "", "type": "query" }, { "name": "contact_preference", "value": "", "type": "query" }, { "name": "entry", "value": "", "type": "query" }, { "name": "lead_id", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query" }, { "name": "results_limit", "value": "", "type": "query" }, { "name": "s_query", "value": "", "type": "query" }, { "name": "sender", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "mode", "value": "", "type": "query" } ] }, "docs": "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 " } ] }, { "info": { "name": "subpackage_smsTemplates", "type": "folder" }, "items": [ { "info": { "name": "List SMS templates", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/sms_template/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." } ] }, "docs": "List SMS templates" }, { "info": { "name": "Create an SMS template", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/sms_template/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an SMS template" }, { "info": { "name": "Fetch an SMS template", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/sms_template/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "include_attachments", "value": "", "type": "query", "description": "Include file attachments in the response." }, { "name": "include_embedded", "value": "", "type": "query", "description": "Include embedded templates used by Workflows." } ] }, "docs": "Fetch an SMS template" }, { "info": { "name": "Update an SMS template", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/sms_template/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an SMS template" }, { "info": { "name": "Delete an SMS template", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/sms_template/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an SMS template" } ] }, { "info": { "name": "subpackage_outcomes", "type": "folder" }, "items": [ { "info": { "name": "List or filter outcomes", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/outcome/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Fetch a list of outcomes." }, { "info": { "name": "Create an outcome", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/outcome/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new outcome for the organization." }, { "info": { "name": "Fetch a single outcome", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/outcome/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Fetch a single outcome" }, { "info": { "name": "Update an outcome", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/outcome/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing outcome." }, { "info": { "name": "Delete an outcome", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/outcome/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "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." } ] }, { "info": { "name": "subpackage_playbooks", "type": "folder" }, "items": [ { "info": { "name": "List or filter playbooks", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/playbook/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "is_archived", "value": "", "type": "query", "description": "Filter for archived or not-archived playbooks. When not provided, both archived and not-archived playbooks will be returned." }, { "name": "position__gt", "value": "", "type": "query", "description": "Filters for where the playbook's `position` is greater than the given value." }, { "name": "created_at__lt", "value": "", "type": "query", "description": "Filters for where the playbook's `created_at` (creation date) is before the given value." } ] }, "docs": "Fetch a list of playbooks for the organization. Results are sorted by position ascending." }, { "info": { "name": "Create a playbook", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/playbook/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new playbook for the organization." }, { "info": { "name": "Fetch a single playbook", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/playbook/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Fetch a single playbook" }, { "info": { "name": "Update a playbook", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/playbook/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing playbook." }, { "info": { "name": "Delete a playbook", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/playbook/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an existing playbook." }, { "info": { "name": "Archive a playbook", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/playbook/:id/archive/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Archive an existing playbook. Archived playbooks are hidden from active listings but retain their associated history." }, { "info": { "name": "Unarchive a playbook", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/playbook/:id/unarchive/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Restore a previously archived playbook to active status." } ] }, { "info": { "name": "subpackage_schedulingLinks", "type": "folder" }, "items": [ { "info": { "name": "List User Scheduling Links", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/scheduling_link/", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "List User Scheduling Links" }, { "info": { "name": "Create a User Scheduling Link", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/scheduling_link/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a User Scheduling Link" }, { "info": { "name": "Create or update a Scheduling Link via OAuth", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/scheduling_link/integration/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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_i" }, { "info": { "name": "Delete a User Scheduling Link via OAuth integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/scheduling_link/integration/:source_id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "source_id", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Fetch a User Scheduling Link", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/scheduling_link/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Fetch a User Scheduling Link" }, { "info": { "name": "Update a User Scheduling Link", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/scheduling_link/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a User Scheduling Link" }, { "info": { "name": "Delete a User Scheduling Link", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/scheduling_link/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a User Scheduling Link" }, { "info": { "name": "List Shared Scheduling Links", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/shared_scheduling_link/", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "List Shared Scheduling Links" }, { "info": { "name": "Create a Shared Scheduling Link", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/shared_scheduling_link/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Shared Scheduling Link" }, { "info": { "name": "Fetch a Shared Scheduling Link", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/shared_scheduling_link/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Fetch a Shared Scheduling Link" }, { "info": { "name": "Update a Shared Scheduling Link", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/shared_scheduling_link/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Shared Scheduling Link" }, { "info": { "name": "Delete a Shared Scheduling Link", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/shared_scheduling_link/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a Shared Scheduling Link" }, { "info": { "name": "Map a Shared Scheduling Link", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/shared_scheduling_link_association/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Map a Shared Scheduling Link to either a User Scheduling Link or a URL.\n\nSee the examples below for both mapping options." }, { "info": { "name": "Unmap a Shared Scheduling Link", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/shared_scheduling_link_association/unmap/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unmap a Shared Scheduling Link" } ] }, { "info": { "name": "subpackage_connectedAccounts", "type": "folder" }, "items": [ { "info": { "name": "List connected accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/connected_account/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_fields", "value": "", "type": "query" }, { "name": "user_id", "value": "", "type": "query" } ] }, "docs": "You can filter down to a specific user by passing the `?user_id` query parameter." }, { "info": { "name": "Fetch a single connected account", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/connected_account/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query" } ] }, "docs": "Fetch a single connected account" } ] }, { "info": { "name": "subpackage_sendAs", "type": "folder" }, "items": [ { "info": { "name": "List Send As Associations", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/send_as/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "allowed_user_id", "value": "", "type": "query" }, { "name": "allowing_user_id", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Create a Send As Association", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/send_as/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a send-as permission. The `allowing_user_id` must be equal to your own user ID." }, { "info": { "name": "Delete a Send As Association by allowed user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/send_as/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "allowed_user_id", "value": "", "type": "query" }, { "name": "allowing_user_id", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Edit Send As Associations in bulk", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/send_as/bulk/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Retrieve a single Send As Association", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/send_as/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve a single Send As Association" }, { "info": { "name": "Delete a Send As Association by ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/send_as/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a Send As Association by ID" } ] }, { "info": { "name": "subpackage_unsubscribedEmails", "type": "folder" }, "items": [ { "info": { "name": "List all unsubscribed emails", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/unsubscribe/email/", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "Get a list of unsubscribed email addresses." }, { "info": { "name": "Unsubscribe an email address", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/unsubscribe/email/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Resubscribe an email address", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/unsubscribe/email/:email_address/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "email_address", "value": "", "type": "path" } ] }, "docs": "Resubscribe an email address" } ] }, { "info": { "name": "subpackage_phoneNumbers", "type": "folder" }, "items": [ { "info": { "name": "List or search for phone numbers", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/phone_number/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." }, { "name": "number", "value": "", "type": "query" }, { "name": "user_id", "value": "", "type": "query" }, { "name": "is_group_number", "value": "", "type": "query" } ] }, "docs": "List or search for phone numbers" }, { "info": { "name": "Request an internal phone number", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/phone_number/request/internal/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Renting a phone number incurs a cost. You need the \"Manage Group 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`" }, { "info": { "name": "Retrieve a single phone number", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/phone_number/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Retrieve a single phone number" }, { "info": { "name": "Update a phone number", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/phone_number/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "You need the \"Manage Group 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" }, { "info": { "name": "Delete a phone number", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/phone_number/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "You need the \"Manage Group Phone Numbers\" permission to delete a group number. You can only delete your own personal numbers." } ] }, { "info": { "name": "subpackage_blockedPhoneNumbers", "type": "folder" }, "items": [ { "info": { "name": "List Blocked Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/blocked_phone_number/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "List Blocked Phone Numbers" }, { "info": { "name": "Create a Blocked Phone Number", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/blocked_phone_number/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Retrieve Blocked Phone Number settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/blocked_phone_number/settings/", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "Retrieve Blocked Phone Number settings" }, { "info": { "name": "Update Blocked Phone Number settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/blocked_phone_number/settings/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Blocked Phone Number settings" }, { "info": { "name": "Retrieve a single Blocked Phone Number", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/blocked_phone_number/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Retrieve a single Blocked Phone Number" }, { "info": { "name": "Update a Blocked Phone Number", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/blocked_phone_number/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Blocked Phone Number" }, { "info": { "name": "Delete a Blocked Phone Number", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/blocked_phone_number/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "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." } ] }, { "info": { "name": "subpackage_dialers", "type": "folder" }, "items": [ { "info": { "name": "List or filter all dialer sessions", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/dialer/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "organization_id", "value": "", "type": "query" }, { "name": "source_type", "value": "", "type": "query" }, { "name": "source_value", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "status__in", "value": "", "type": "query" }, { "name": "user_id", "value": "", "type": "query" }, { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." } ] }, "docs": "List or filter all dialer sessions" }, { "info": { "name": "Get a single dialer session", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/dialer/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "organization_id", "value": "", "type": "query" } ] }, "docs": "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." } ] }, { "info": { "name": "subpackage_users", "type": "folder" }, "items": [ { "info": { "name": "Fetch information about yourself", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/me/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "A special instance of the Users endpoint for the current user. Useful for determining your own `id` and `organization_id`." }, { "info": { "name": "List users in your organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/user/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_order_by", "value": "", "type": "query" }, { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." } ] }, "docs": "List all the users who are members of the same organizations as you are." }, { "info": { "name": "List user availability statuses", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/user/availability/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "organization_id", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Fetch a single user", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/user/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_order_by", "value": "", "type": "query" }, { "name": "_limit", "value": "", "type": "query", "description": "Number of results to return." }, { "name": "_skip", "value": "", "type": "query", "description": "Number of results to skip before returning, for pagination." } ] }, "docs": "Fetch a single user" } ] }, { "info": { "name": "subpackage_organizations", "type": "folder" }, "items": [ { "info": { "name": "Get an organization's details", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/organization/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_expand", "value": "", "type": "query" } ] }, "docs": "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`." }, { "info": { "name": "Update an organization", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/organization/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_expand", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an organization's `name`, `currency`, and reorder existing `lead_statuses`." } ] }, { "info": { "name": "subpackage_memberships", "type": "folder" }, "items": [ { "info": { "name": "Create a membership", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/membership/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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\n`role_id` can be one of `'admin'`, `'superuser'`, `'user'` or `'restricteduser'` for the corresponding predefined role, or an ID of a [Role](https://developer.close.com/api/resources/roles).\n\nThis request requires \"Manage Organization\" permissions.\n\nAPI access to this endpoint is supported " }, { "info": { "name": "Bulk update memberships", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/membership/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Any field that can be updated on a membership individually can also be used to bulk update multiple memberships. To issue a bulk update, pass their comma separated ids into `id__in` in `_params` as shown in the example below." }, { "info": { "name": "Update a membership", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/membership/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "You can update the field `role_id` and its value can be one of `'admin'`, `'superuser'`, `'user'` or `'restricteduser'` for the corresponding predefined role, or an ID of a [Role](https://developer.close.com/api/resources/roles).\n\nThe field `auto_record_calls` is used to manage whether or not calls are automatically recorded. The initial value for a membership is `'unset'`. It can be updated to `'disabled'`, or `'enabled'`." }, { "info": { "name": "Get pinned views for a membership", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/membership/:id/pinned_views/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get the ordered list of pinned views for the given membership." }, { "info": { "name": "Update pinned views for a membership", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/membership/:id/pinned_views/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set the pinned views for the given membership. Provide an ordered list that will overwrite the entire current list." } ] }, { "info": { "name": "subpackage_roles", "type": "folder" }, "items": [ { "info": { "name": "List all the roles defined for your organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/role/", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "List all the roles defined for your organization" }, { "info": { "name": "Create a new role", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/role/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "`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` - le" }, { "info": { "name": "Fetch a single role", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/role/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Fetch a single role" }, { "info": { "name": "Update existing role", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/role/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update existing role" }, { "info": { "name": "Delete a role", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/role/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a custom role. You must first move all users off this role by reassigning them to another role." } ] }, { "info": { "name": "subpackage_groups", "type": "folder" }, "items": [ { "info": { "name": "List Groups for your organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/group/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Note that list endpoint does not support retrieving members for all groups. Use individual group endpoint instead." }, { "info": { "name": "Create a Group", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/group/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Add a User to a Group", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/group/:group_id/member/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "group_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a user to a group by providing the `user_id`. If the user is already a member, nothing changes." }, { "info": { "name": "Remove a User from a Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/group/:group_id/member/:user_id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "group_id", "value": "", "type": "path" }, { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "If the user is not a member of the group, nothing changes." }, { "info": { "name": "Fetch an individual Group", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/group/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ] }, "docs": "Fetch an individual Group" }, { "info": { "name": "Update a Group", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/group/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "_fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response." } ], "body": { "type": "json", "data": "{}" } }, "docs": "You can use this endpoint to rename a Group. If a name is not unique, an error will be returned." }, { "info": { "name": "Delete a Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/group/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "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." } ] } ], "bundled": true }