{ "opencollection": "1.0.0", "info": { "name": "API Endpoints subpackage_activities subpackage_contacts API", "version": "1.0.0" }, "items": [ { "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" } ] } ], "bundled": true }