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