Guides
Signup For Free

Close CRM API Integration

Suggest Edits

These are the list of integration use cases supported by Knit for Close CRM API as part of the CRM category

Delete a Contact

  • ID: delete_a_contact
  • Operation: write
  • Entities: contact
  • Summary: This API endpoint deletes a contact from the system. It requires the contact's unique identifier as a path parameter. The request must include the 'Accept' header set to 'application/json' and use basic authentication with the API key as the username. Upon successful deletion, the response will be an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Group

  • ID: delete_a_group
  • Operation: write
  • Entities: view, report, group
  • Summary: The 'Delete a Group' API endpoint allows the deletion of a specified group by its unique identifier. This operation is only permitted if the group is not referenced by any saved reports or smart views. The request requires an API key for authentication and must include the 'Accept: application/json' header. The response is an empty JSON object, indicating that the group has been successfully deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Lead

  • ID: delete_a_lead
  • Operation: write
  • Entities: lead
  • Summary: The 'Delete a Lead' API allows users to delete a specific lead from the system using its unique identifier. The request requires the 'id' of the lead to be specified in the path parameters and the 'Accept' header to be set to 'application/json'. The API responds with an empty body upon successful deletion of the lead.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Lead Status

  • ID: delete_a_lead_status
  • Operation: write
  • Entities: status, lead
  • Summary: This API endpoint deletes a lead status identified by the 'status_id' from the system. Before making this request, ensure that no leads are assigned to this status. The request requires an API key for authentication and must include the 'Accept: application/json' header. The response is an empty JSON object, indicating that the lead status has been successfully deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Phone Number

  • ID: delete_a_phone_number
  • Operation: write
  • Entities: phone number, user, permission
  • Summary: This API endpoint allows the deletion of a phone number using the DELETE method. The user must have the 'Manage Group Phone Numbers' permission to delete a group number, and can only delete their own personal numbers. The request requires basic authentication with an API key and the 'Accept' header set to 'application/json'. The phone number to be deleted is specified by its unique identifier in the path parameter. A successful response returns an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Pipeline

  • ID: delete_a_pipeline
  • Operation: write
  • Entities: pipeline, opportunity status
  • Summary: The 'Delete a Pipeline' API endpoint allows users to delete a specific pipeline identified by its 'pipeline_id'. This operation is only permitted if the pipeline does not contain any Opportunity Statuses. Users must ensure that all Opportunity Statuses are either deleted or moved to another pipeline before attempting to delete the pipeline. The request requires an API key for authentication and must include the 'Accept: application/json' header. The response is an empty JSON object, indicating successful deletion.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Role

  • ID: delete_a_role
  • Operation: write
  • Entities: user, role
  • Summary: This API endpoint deletes a role identified by the 'role_id' from the system. Before calling this API, ensure that all users associated with this role have been moved to a different role by updating their 'role_id' attribute. The request requires an 'Accept' header specifying 'application/json'. The response is an empty JSON object, indicating successful deletion.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Sequence

  • ID: delete_a_sequence
  • Operation: write
  • Entities: sequence
  • Summary: The 'Delete a Sequence' API endpoint allows users to delete a specific sequence identified by its unique ID. The request requires basic authentication using an API key and must include the 'Accept: application/json' header. The sequence ID is specified as a path parameter. Upon successful deletion, the API returns an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Task

  • ID: delete_a_task
  • Operation: write
  • Entities: task
  • Summary: The 'Delete a Task' API allows users to delete a specific task by its unique identifier. The request requires the task ID to be specified in the path parameters and the 'Accept' header to be set to 'application/json'. The response is an empty JSON object, indicating that the task has been successfully deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an Activity Custom Field

  • ID: delete_activity_custom_field
  • Operation: write
  • Entities: custom field, activity
  • Summary: The 'Delete an Activity Custom Field' API allows users to delete a specific custom field associated with an activity. The request requires the 'custom_field_id' as a path parameter to identify which custom field to delete. The request must include the 'Accept' header set to 'application/json' and use basic authentication with an API key. Upon successful deletion, the response will be an empty JSON object, and the field will immediately disappear from any Custom Activity API responses.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an Email Template

  • ID: delete_an_email_template
  • Operation: write
  • Entities: email template
  • Summary: This API endpoint deletes an email template identified by its unique ID. The request requires basic authentication using an API key and accepts a JSON response. The 'id' path parameter is mandatory and specifies the email template to be deleted. Upon successful deletion, the API returns an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an Opportunity

  • ID: delete_an_opportunity
  • Operation: write
  • Entities: opportunity
  • Summary: This API endpoint deletes an opportunity identified by its unique ID. The request requires basic authentication using an API key and the 'Accept' header set to 'application/json'. The ID of the opportunity to be deleted must be provided as a path parameter. Upon successful deletion, the API returns an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Call Activity

  • ID: delete_call_activity
  • Operation: write
  • Entities: call, activity
  • Summary: This API endpoint deletes a specific call activity identified by its unique ID. The request requires an API key for authentication, which should be included in the Authorization header. The Accept header must specify 'application/json'. The ID of the call activity to be deleted is provided as a path parameter. Upon successful deletion, the API returns an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Contact Custom Field

  • ID: delete_contact_custom_field
  • Operation: delete
  • Entities: contact, custom field
  • Summary: This API endpoint deletes a custom field from a contact in the Close API. The DELETE request requires the custom_field_id as a path parameter to specify which custom field to delete. The request must include an 'Accept' header set to 'application/json' and an 'Authorization' header with a valid API key. Upon successful deletion, the response will be an empty JSON object, and the custom field will immediately disappear from any Contact API responses.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Custom Activity Instance

  • ID: delete_custom_activity_instance
  • Operation: write
  • Entities: instance, activity, custom activity
  • Summary: This API endpoint deletes a custom activity instance identified by the given ID. The request requires the 'Accept' header to specify the media type as 'application/json' and uses basic authentication with the API key. The ID of the custom activity instance to be deleted must be provided as a path parameter. Upon successful deletion, the API returns an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Custom Activity Type

  • ID: delete_custom_activity_type
  • Operation: write
  • Entities: custom activity type
  • Summary: This API endpoint deletes a custom activity type identified by its unique ID. The request requires the 'Accept' header to specify the media type as 'application/json'. The 'id' path parameter is mandatory and should be replaced with the actual ID of the custom activity type to be deleted. Upon successful deletion, the API returns an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Custom Object Custom Field

  • ID: delete_custom_object_custom_field
  • Operation: write
  • Entities: custom field, custom object
  • Summary: This API endpoint deletes a custom field from a custom object type. The DELETE request requires the 'custom_field_id' as a path parameter to specify which custom field to delete. The request must include an 'Accept' header with the value 'application/json'. Upon successful deletion, the response will be an empty JSON object, and the field will immediately disappear from any Custom Object API responses.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Custom Object Instance

  • ID: delete_custom_object_instance
  • Operation: write
  • Entities: instance, custom object
  • Summary: This API endpoint deletes a specific instance of a custom object identified by its unique ID. The request requires an API key for authentication and must include the 'Accept' header set to 'application/json'. The ID of the custom object instance to be deleted is specified in the path parameters. Upon successful deletion, the API returns an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Custom Object Type

  • ID: delete_custom_object_type
  • Operation: write
  • Entities: custom object type
  • Summary: This API endpoint deletes a custom object type identified by its unique ID. The request requires an API key for authentication, which should be included in the Authorization header in the format 'YOUR_API_KEY:'. The Accept header must specify 'application/json'. The ID of the custom object type to be deleted is provided as a path parameter. A successful response returns an empty JSON object, indicating that the custom object type has been deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Disassociate a Shared Custom Field from an Object

  • ID: delete_disassociate_shared_custom_field
  • Operation: write
  • Entities: contact, custom field, lead
  • Summary: This API endpoint allows you to disassociate a shared custom field from a specified object type, such as a Lead, Contact, Opportunity, Custom Activity Type, or Custom Object Type. The endpoint requires the custom field ID and the object type as path parameters. The object type can be specified as 'lead', 'contact', 'opportunity', 'custom_activity_type/<catype_id>', or 'custom_object_type/<cotype_id>'. The request must include the 'Accept: application/json' header. Upon successful disassociation, the response will be an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an Email Activity

  • ID: delete_email_activity
  • Operation: write
  • Entities: email, activity
  • Summary: This API endpoint deletes an email activity specified by its unique identifier. The request requires the 'Accept' header to specify the response format as 'application/json' and uses basic authentication with an API key. The 'id' path parameter is required to identify the specific email activity to delete. Upon successful deletion, the response is an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an EmailThread Activity

  • ID: delete_emailthread_activity
  • Operation: write
  • Entities: email thread, email activity, activity
  • Summary: The 'Delete an EmailThread Activity' API endpoint allows users to delete a specific email thread and all associated email activities. The request requires the unique identifier of the email thread to be specified in the path parameters. The 'Accept' header must be set to 'application/json'. Upon successful deletion, the API returns an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an Integration Link

  • ID: delete_integration_link
  • Operation: write
  • Entities: integration link
  • Summary: The 'Delete an Integration Link' API endpoint allows users to delete a specific integration link by its unique identifier. The request requires the 'id' of the integration link to be specified in the path parameters. The request must include the 'Accept' header set to 'application/json' and use basic authentication with the API key. The response is an empty JSON object, indicating that the integration link has been successfully deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Lead Custom Field

  • ID: delete_lead_custom_field
  • Operation: write
  • Entities: custom field, lead
  • Summary: This API endpoint deletes a custom field from a lead. The DELETE request requires the custom field ID as a path parameter and uses basic authentication with an API key. The 'Accept' header must be set to 'application/json'. Upon successful deletion, the custom field will immediately disappear from any Lead API responses, and the response will be an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Meeting Activity

  • ID: delete_meeting_activity
  • Operation: write
  • Entities: activity, meeting
  • Summary: This API endpoint deletes a specific meeting activity identified by its unique ID. The request requires an API key for authentication, which is passed in the Authorization header. The Accept header must specify 'application/json'. The ID of the meeting activity to be deleted is included in the path parameters. A successful response returns an empty JSON object, indicating that the meeting activity has been successfully deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Note Activity

  • ID: delete_note_activity
  • Operation: write
  • Entities: activity, note
  • Summary: The 'Delete a Note Activity' API endpoint allows users to delete a specific note activity by its unique identifier. The request requires the 'id' of the note activity to be specified in the path parameters. The request must include the 'Accept' header set to 'application/json' and use basic authentication with an API key. The response is an empty JSON object, indicating that the note activity has been successfully deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an Opportunity Custom Field

  • ID: delete_opportunity_custom_field
  • Operation: write
  • Entities: custom field, opportunity
  • Summary: This API endpoint deletes a custom field from an opportunity in the Close CRM system. The DELETE request requires the custom field ID as a path parameter and uses basic authentication with an API key. The 'Accept' header must be set to 'application/json'. Upon successful deletion, the custom field will immediately disappear from any Opportunity API responses, and the response will be an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an Opportunity Status

  • ID: delete_opportunity_status
  • Operation: write
  • Entities: status, opportunity
  • Summary: This API endpoint deletes an opportunity status identified by the 'status_id' path parameter. Before using this endpoint, ensure that no opportunities are assigned to this status. The request requires an 'Accept' header set to 'application/json' and basic authentication using an API key. The response is an empty JSON object, indicating that the deletion was successful.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Send As Association by Allowed User

  • ID: delete_send_as_association_by_allowed_user
  • Operation: write
  • Entities: send as association, user
  • Summary: This API endpoint allows you to delete a 'Send As' association between two users. The DELETE request requires the 'allowing_user_id' and 'allowed_user_id' as query parameters. The 'allowing_user_id' must be equal to your user ID. The request must include the 'Accept: application/json' header. Upon successful deletion, the API returns no content.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Send As Association by ID

  • ID: delete_send_as_association_by_id
  • Operation: write
  • Entities: send as association
  • Summary: This API endpoint deletes a Send As association by its unique ID. The request requires the ID of the Send As association to be specified in the path parameters. The request must include the 'Accept' header set to 'application/json' and use basic authentication with an API key. Upon successful deletion, the API returns no content.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Shared Custom Field

  • ID: delete_shared_custom_field
  • Operation: write
  • Entities: contact, custom field, lead
  • Summary: This API deletes a shared custom field identified by the 'custom_field_id' from the system. The DELETE request requires the 'Accept' header to specify the response format as 'application/json'. The 'custom_field_id' is a required path parameter that specifies which custom field to delete. Upon successful deletion, the field will immediately disappear from any objects it was assigned to and from any related APIs, such as Lead, Contact, or Custom Activity APIs. The response is an empty JSON object indicating the operation was successful.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Shared Scheduling Link

  • ID: delete_shared_scheduling_link
  • Operation: write
  • Entities: shared scheduling link
  • Summary: The 'Delete a Shared Scheduling Link' API endpoint allows users to delete a shared scheduling link by specifying its unique identifier in the path parameters. The request requires basic authentication using an API key and the 'Accept' header to specify the response format as JSON. The response is an empty JSON object, indicating successful deletion.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a single LeadStatusChange activity

  • ID: delete_single_leadstatuschange_activity
  • Operation: write
  • Entities: activity feed, lead status change activity, lead
  • Summary: This API endpoint deletes a single LeadStatusChange activity from a lead's activity feed. It is used to remove irrelevant status change events that may cause integration issues with other systems. The DELETE request requires the unique identifier of the LeadStatusChange activity in the path parameter. The request must include an 'Accept' header with the value 'application/json'. The response is an empty JSON object, indicating successful deletion.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Single OpportunityStatusChange Activity

  • ID: delete_single_opportunity_statuschange_activity
  • Operation: write
  • Entities: opportunity status change, opportunity, lead
  • Summary: This API endpoint deletes a single OpportunityStatusChange activity. It is used to remove a status change event from a Lead's activity feed without altering the actual status of the Opportunity. This is particularly useful when the status change is irrelevant or causing integration issues with another system. The request requires the unique identifier of the OpportunityStatusChange to be deleted, and it must include the 'Accept' header set to 'application/json' and basic authentication using an API key. The response is an empty object indicating successful deletion.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Smart View

  • ID: delete_smart_view
  • Operation: write
  • Entities: saved search, smart view
  • Summary: The 'Delete a Smart View' API allows users to delete a saved search by specifying its unique identifier in the path parameters. The request requires an 'Accept' header with the value 'application/json'. Upon successful deletion, the API returns an empty JSON object in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an SMS activity

  • ID: delete_sms_activity
  • Operation: write
  • Entities: sms, activity, id
  • Summary: This API endpoint deletes an SMS activity identified by its unique ID. The request requires basic authentication using an API key and the 'Accept' header set to 'application/json'. The ID of the SMS activity to be deleted must be provided as a path parameter. Upon successful deletion, the API returns an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an SMS Template

  • ID: delete_sms_template
  • Operation: write
  • Entities: sms template
  • Summary: This API endpoint deletes an SMS template identified by its unique ID. The request requires basic authentication using an API key and must include the 'Accept' header set to 'application/json'. The ID of the SMS template to be deleted is specified as a path parameter. Upon successful deletion, the API returns an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a TaskCompleted Activity

  • ID: delete_taskcompleted_activity
  • Operation: write
  • Entities: task completed, activity, task
  • Summary: This API endpoint deletes a TaskCompleted activity identified by its unique ID. The request requires an API key for authentication, which should be included in the Authorization header as a Basic token. The Accept header must specify 'application/json'. The ID of the TaskCompleted activity to be deleted is provided as a path parameter. A successful deletion returns an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a User Scheduling Link

  • ID: delete_user_scheduling_link
  • Operation: write
  • Entities: scheduling link, user
  • Summary: This API endpoint deletes a user scheduling link identified by the given ID. The request requires an API key for authentication and the 'Accept' header to specify the response format as JSON. The path parameter 'id' is mandatory and specifies the unique identifier of the scheduling link to be deleted. Upon successful deletion, the API returns an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete User Scheduling Link by Source ID via OAuth

  • ID: delete_user_scheduling_link_by_source_id_via_oauth
  • Operation: write
  • Entities: scheduling link, user, OAuth application
  • Summary: This API endpoint allows OAuth applications to delete a User Scheduling Link identified by the 'source_id'. The request must be made using OAuth authentication, and the 'Accept' header must be set to 'application/json'. The 'source_id' is a required path parameter that specifies the User Scheduling Link to be deleted. The response does not return any content.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Webhook Subscription

  • ID: delete_webhook_subscription
  • Operation: write
  • Entities: webhook subscription
  • Summary: The Delete Webhook Subscription API allows users to delete a specific webhook subscription by its unique identifier. The request requires the API key for authentication and the 'Accept' header to specify the response format. The 'id' path parameter is mandatory and specifies the webhook subscription to be deleted. Upon successful deletion, the API returns an empty JSON object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Contacts API

  • ID: get_list_contacts
  • Operation: read
  • Entities: contact, email, phone
  • Summary: The List Contacts API retrieves a list of contacts from the Close API. It requires an API key for authentication and returns a JSON response containing contact details such as name, title, phone numbers, emails, and other metadata. The request must include the 'Accept' header set to 'application/json' and the 'Authorization' header with the API key. The response includes a 'has_more' boolean indicating if more contacts are available and a 'data' array with contact objects.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve List of All Leads

  • ID: get_list_of_all_leads
  • Operation: read
  • Entities: contact, lead, opportunity
  • Summary: The Retrieve List of All Leads API allows users to fetch a list of leads from the Close API. The request is made using the GET method to the endpoint 'https://api.close.com/api/v1/lead/'. The API accepts query parameters such as '_limit' to specify the number of leads to return, '_skip' to skip a certain number of leads, and '_fields' to specify which fields to include in the response. The request must include an 'Accept' header with the value 'application/json'. The response includes a boolean 'has_more' indicating if more leads are available, 'total_results' showing the total number of leads, and a 'data' array containing detailed information about each lead, including status, contacts, opportunities, and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List or Filter All Call Activities

  • ID: get_list_or_filter_all_call_activities
  • Operation: read
  • Entities: call, lead, user
  • Summary: This API retrieves a list of call activities or filters them based on specific criteria. The request is made using the GET method to the endpoint '/activity/call/'. The API accepts query parameters such as 'lead_id', 'user_id', 'date_createdgt', and 'date_createdlt' to filter the results. The response includes a boolean 'has_more' indicating if more results are available and a 'data' array containing details of each call activity, such as organization ID, call type, direction, disposition, phone numbers, user and lead IDs, and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List or Filter All Email Activities

  • ID: get_list_or_filter_all_email_activities
  • Operation: read
  • Entities: activity, email, lead
  • Summary: The 'List or Filter All Email Activities' API allows users to retrieve a list of email activities from the Close platform. This API endpoint supports filtering by lead ID, user ID, and creation date range. The request requires an 'Accept' header with the value 'application/json'. The response includes details of each email activity, such as the email ID, type, organization ID, lead ID, contact ID, creation and update timestamps, user information, email direction, sender and recipient details, subject, body content, attachments, and status. The response also indicates if there are more email activities to fetch.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List or Filter All Meeting Activities

  • ID: get_list_or_filter_all_meeting_activities
  • Operation: read
  • Entities: attendee, meeting, user
  • Summary: This API endpoint allows you to list or filter all meeting activities. You can filter meetings by lead ID, user ID, and creation date range using query parameters. The response includes detailed information about each meeting, such as the title, attendees, duration, and status. The API returns a list of meetings with attributes like date updated, created by, attendees, and more. The response also indicates if there are more meetings to fetch.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List or Filter Opportunities

  • ID: get_list_or_filter_opportunities
  • Operation: read
  • Entities: lead, opportunity, user
  • Summary: The List or Filter Opportunities API allows users to retrieve a list of opportunities based on various filtering criteria. The API supports filtering by lead ID, user ID, status ID, status label, status type, creation date, update date, winning date, value period, and more. Users can also specify ordering and grouping of results. The response includes aggregate values such as total results, count by value period, total and expected values for different periods, and a list of opportunity objects with detailed information. The API supports pagination and provides options for grouping results by user, date, or other criteria.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List or Filter Tasks API

  • ID: get_list_or_filter_tasks
  • Operation: read
  • Entities: call, email, task
  • Summary: The List or Filter Tasks API allows users to retrieve a list of tasks based on various filter criteria. The API supports filtering by task ID, type, lead ID, completion status, date, and assigned user. It also allows ordering by date or date_created. The response includes detailed information about each task, such as type, view, assigned user, contact details, creation and update dates, and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add a User to a Group

  • ID: post_add_user_to_group
  • Operation: write
  • Entities: member, group, user
  • Summary: This API endpoint allows you to add a user to a specified group by providing the group ID and user ID. The request is made using the POST method to the URL https://api.close.com/api/v1/group/{group_id}/member/. The request headers must include 'Content-Type' and 'Accept' set to 'application/json', and an 'Authorization' header with the API key. The path parameter 'group_id' specifies the group to which the user will be added, and the request body must include the 'user_id' of the user to be added. If the user is already a member of the group, no changes are made. The response returns the 'user_id' of the user that was added.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Associate a Shared Custom Field with an Object Type

  • ID: post_associate_shared_custom_field
  • Operation: write
  • Entities: contact, custom field, lead
  • Summary: This API endpoint associates a shared custom field with an object type such as Lead, Contact, Opportunity, Custom Activity Type, or Custom Object Type. The request requires specifying the object_type and optionally the custom_activity_type_id or custom_object_type_id if applicable. The editable_with_roles parameter allows specifying which roles can edit the field, and the required parameter indicates if the field is mandatory for the object. The response echoes back the association details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Comment

  • ID: post_create_a_comment
  • Operation: write
  • Entities: thread, object, comment
  • Summary: The 'Create a Comment' API allows users to add a comment to an object. If a comment thread already exists for the object, the new comment is added to the existing thread. If no thread exists, a new one is created. The request requires the 'object_id' of the object to comment on and the 'body' of the comment in HTML format. The response includes details of the created comment, such as its ID, the thread ID, associated lead and organization IDs, the comment content, and metadata about its creation and updates.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Group

  • ID: post_create_a_group
  • Operation: write
  • Entities: member, group, organization
  • Summary: This API endpoint allows the creation of a new group with no initial users. The group is created by sending a POST request to the specified URL with the group name in the request body. The request must include 'Content-Type' and 'Accept' headers set to 'application/json'. Optionally, a '_fields' query parameter can be used to specify which fields to include in the response. The response includes the unique identifier of the group, its name, an empty list of members, and the organization ID to which the group belongs. To add or remove members, use the member endpoint.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Task

  • ID: post_create_a_task
  • Operation: write
  • Entities: lead, task, user
  • Summary: The 'Create a Task' API allows users to create a new task of type 'lead'. The request requires a JSON body with the following fields: 'lead_id' (the ID of the lead associated with the task), 'assigned_to' (the user ID to whom the task is assigned), 'text' (a description of the task), 'date' (the date for the task in YYYY-MM-DD format), and 'is_complete' (a boolean indicating if the task is complete). The response returns a JSON object containing details of the created task, including the task ID, assigned user details, creation and update timestamps, and other relevant information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a new Activity Custom Field

  • ID: post_create_activity_custom_field
  • Operation: write
  • Entities: activity custom field, user, custom activity type
  • Summary: This API endpoint allows you to create a new Activity Custom Field for a specified Custom Activity Type. The request requires a JSON body with the following fields: 'custom_activity_type_id' (the ID of the Custom Activity Type), 'name' (the name of the custom field), 'type' (the type of the custom field), 'required' (whether the field is required to publish the activity), 'accepts_multiple_values' (whether the field accepts multiple values), and 'editable_with_roles' (an array of roles that can edit the field). The response returns the details of the created custom field, including its ID, name, type, and other metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a new Contact Custom Field

  • ID: post_create_contact_custom_field
  • Operation: write
  • Entities: contact, custom field, organization
  • Summary: This API endpoint allows you to create a new custom field for a contact. The request requires a JSON body with the field's name, description, type, and choices. The response returns the details of the created custom field, including its ID, name, description, type, choices, and metadata such as creation and update timestamps, and the user and organization associated with it.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Contact Smart View

  • ID: post_create_contact_smart_view
  • Operation: write
  • Entities: saved search, contact, organization
  • Summary: This API endpoint allows you to create a Contact Smart View in the system. To create a smart view, you must specify the name of the view, the type of objects (which must be 'contact'), and a search query object that defines the filtering criteria. The search query must include an object_type clause to specify that you want to retrieve contact objects. The response includes details about the created smart view, such as its ID, creation and update timestamps, and the query details. The smart view can be shared with other members and is associated with a specific user and organization.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a new Custom Activity instance

  • ID: post_create_custom_activity_instance
  • Operation: write
  • Entities: user, custom activity, lead
  • Summary: This API endpoint allows the creation of a new Custom Activity instance in the system. The request requires a POST method to the URL 'https://api.close.com/api/v1/activity/custom/'. The request body must include 'custom_activity_type_id', 'lead_id', and custom fields such as 'custom.cf_cSh3fWT3rEJ1BFSezme2YAG6bPrZV5wUWKKrW4iN19g' and 'custom.cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S'. The response includes details about the created activity, such as 'organization_id', 'user_name', 'status', and custom field values. By default, the activity is created with a 'published' status, but it can also be created in 'draft' status if not all required fields are set.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a new Custom Object Custom Field

  • ID: post_create_custom_object_custom_field
  • Operation: write
  • Entities: custom field, user, custom object
  • Summary: This API endpoint allows the creation of a new Custom Object Custom Field. The request requires a JSON body with the custom_object_type_id, name, description, type, and required fields. The response returns the details of the created custom field, including its ID, name, description, type, and other metadata such as creation and update timestamps, and the organization ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a new Custom Object instance

  • ID: post_create_custom_object_instance
  • Operation: write
  • Entities: lead, custom field, custom object
  • Summary: This API endpoint allows you to create a new Custom Object instance in the system. The request requires a POST method to the endpoint '/custom_object/'. The request body must include the 'custom_object_type_id', 'lead_id', and 'name' fields, which are required. Additionally, you can set custom field values using the format 'custom.{custom_field_id}'. The response returns the details of the created Custom Object instance, including its ID, type, associated lead, name, custom field values, creation and update timestamps, and the user and organization information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create an Email Activity

  • ID: post_create_email_activity
  • Operation: write
  • Entities: template, email, attachment
  • Summary: This API endpoint allows you to create an email activity in the Close platform. You can specify various parameters such as contact_id, user_id, lead_id, direction, subject, sender, recipients (to, cc, bcc), status, body_text, body_html, attachments, email_account_id, and template_id. The status of the email can be 'inbox', 'draft', 'scheduled', 'outbox', or 'sent'. Only drafts can be modified, and their status can be changed to 'scheduled' or 'outbox'. Scheduled emails or emails in outbox that weren't sent yet can be canceled by setting the status back to 'draft'. You can also include attachments by first uploading the file to Close using the Files API and then adding the attachment details in the request body. The response includes details of the created email activity such as id, contact_id, user_id, lead_id, direction, sender, recipients, subject, body_preview, body_text, body_html, status, and attachments.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create an Email Template

  • ID: post_create_email_template
  • Operation: write
  • Entities: email template, attachment
  • Summary: This API endpoint allows the creation of an email template in the system. The request requires a JSON body containing the template's name, subject, body, and optional attachments. The 'is_shared' field indicates if the template is shared. Attachments are specified with their URL, filename, size, and content type. The response returns the details of the created email template, including its ID, organization ID, creation and update timestamps, creator and updater IDs, and attachment details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create an Integration Link

  • ID: post_create_integration_link
  • Operation: write
  • Entities: integration link, organization, lead
  • Summary: This API endpoint allows you to create an integration link in the system. You need to provide the name, URL template, and type of the integration link in the request body. The request must include the 'Content-Type' and 'Accept' headers set to 'application/json', and an 'Authorization' header with your API key. The response will include the organization ID, integration link ID, name, URL template, and type of the created integration link.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a new Lead Custom Field

  • ID: post_create_lead_custom_field
  • Operation: write
  • Entities: custom field, organization, lead
  • Summary: This API endpoint allows you to create a new custom field for a lead in the Close CRM system. The request requires a JSON body with 'name' and 'type' fields, both of which are mandatory. The 'name' specifies the label of the custom field, while 'type' defines the data type of the field. The response returns a JSON object containing details of the newly created custom field, including its unique ID, name, description, type, and metadata such as creation and update timestamps, and the user and organization associated with the field.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Lead Smart View

  • ID: post_create_lead_smart_view
  • Operation: write
  • Entities: query, saved search, lead
  • Summary: This API endpoint allows you to create a Lead Smart View in the system. The request is made to the '/saved_search/' endpoint using the POST method. The request body must include the 'name' of the smart view and an 's_query' object that defines the search criteria. The 'type' field is optional and defaults to 'lead'. The 's_query' object contains a 'query' with a list of conditions to filter leads, such as matching the 'display_name' field with a specific value. The response includes details about the created smart view, such as its 'id', 'name', and 'organization_id'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a new LeadStatusChange activity

  • ID: post_create_lead_status_change_activity
  • Operation: write
  • Entities: status, lead status change, lead
  • Summary: This API endpoint allows you to create a new LeadStatusChange activity. It logs a status change event in the Lead's activity feed without actually changing the status of the Lead. This is useful for importing historical status changes from another organization or system. The request requires a JSON body with 'lead_id', 'old_status_id', 'new_status_id', and 'date_created'. The response includes details about the created activity, such as 'organization_id', 'lead_id', 'new_status_id', 'old_status_id', and user information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Contact

  • ID: post_create_new_contact
  • Operation: write
  • Entities: contact, organization, lead
  • Summary: This API endpoint allows you to create a new contact associated with a specific lead. The request requires a JSON body containing the lead ID, contact name, title, phone numbers, email addresses, URLs, and any custom fields. The response returns the details of the created contact, including its unique ID, organization ID, name, title, creation and update timestamps, and associated phone numbers, emails, and URLs.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create New Custom Activity Type

  • ID: post_create_new_custom_activity_type
  • Operation: write
  • Entities: custom activity type, role, custom activity field
  • Summary: This API endpoint allows the creation of a new custom activity type in the system. The request requires a JSON body with the name, description, a boolean indicating if the type can only be created via API, and an array of roles that can edit the type. The response returns details of the created activity type, including its ID, creation and update timestamps, and the organization it belongs to.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create New Custom Object Type

  • ID: post_create_new_custom_object_type
  • Operation: write
  • Entities: field, custom object type, role
  • Summary: This API endpoint allows the creation of a new Custom Object Type. The request must include the 'name' and 'name_plural' fields, which are required. Optional fields include 'description', 'api_create_only', and 'editable_with_roles'. The response returns details of the created Custom Object Type, including its ID, name, description, and roles that can edit it. The 'api_create_only' field indicates if instances can only be created via the API.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Lead

  • ID: post_create_new_lead
  • Operation: write
  • Entities: address, contact, lead
  • Summary: This API endpoint allows you to create a new lead in the system. You can provide details such as the lead's name, URL, description, status ID, contacts, custom fields, and addresses. The request body must be in JSON format and include the necessary headers for content type and acceptance. The response will include the lead's details, including its status, contacts, addresses, and custom fields, along with metadata such as creation and update timestamps.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Role

  • ID: post_create_new_role
  • Operation: write
  • Entities: role, lead custom field, permission
  • Summary: This API endpoint allows the creation of a new role in the system. The request requires a JSON body with the role's name and a list of permissions. Optionally, it can include visibility_user_lcf_ids, which is a list of Lead Custom Field IDs that define which leads a user with this role can see, and visibility_user_lcf_behavior, which defines how lead visibility works for leads without assigned users. The response returns the details of the created role, including its unique ID, name, editability status, permissions, and visibility settings.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Status for Leads

  • ID: post_create_new_status_for_leads
  • Operation: write
  • Entities: status, organization, lead
  • Summary: This API endpoint allows the creation of a new status that can be applied to leads. The request requires a POST method to the endpoint '/status/lead/' with a JSON body containing the 'label' of the new status. The request headers must include 'Content-Type' and 'Accept' set to 'application/json', and 'Authorization' with a Basic authentication using the API key. The response returns a JSON object containing the 'id' of the new status, the 'label' provided, and the 'organization_id' associated with the status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create new Webhook subscription

  • ID: post_create_new_webhook_subscription
  • Operation: write
  • Entities: event, subscription, webhook
  • Summary: This API endpoint allows you to create a new webhook subscription. You can specify the URL to which the webhook events will be sent and the list of events you want to subscribe to. The request body must include the URL and an array of event objects, each containing an object_type and an action. The response includes details about the created subscription, such as its status, the user who created and last updated it, the subscription ID, and the list of events it is listening to.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create new Webhook Subscription with filters

  • ID: post_create_new_webhook_subscription_with_filters
  • Operation: write
  • Entities: webhook subscription, event, filter
  • Summary: This API endpoint allows the creation of a new webhook subscription with specific filters. The request requires a URL to which the webhook will send POST requests and a list of events to subscribe to. Each event can have an object type, an action, and an optional extra filter. The response includes details about the created webhook subscription, such as its status, URL, creation and update timestamps, and the events it is subscribed to.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Note Activity

  • ID: post_create_note_activity
  • Operation: write
  • Entities: lead, note, attachment
  • Summary: The Create a Note Activity API allows you to create a note associated with a specific lead in the Close application. The request requires a JSON body containing the HTML content of the note ('note_html'), the ID of the lead ('lead_id'), and optionally an array of attachments. Each attachment must include the 'content_type', 'filename', and 'url' fields. The URL must be obtained from the Files API and should start with 'https://app.close.com/go/file/'. The response returns the details of the created note, including its HTML and plain text content, attachments, user information, and timestamps.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create an Opportunity

  • ID: post_create_opportunity
  • Operation: write
  • Entities: status, custom field, opportunity
  • Summary: The Create an Opportunity API allows users to create a new opportunity within the system. Users can specify various parameters such as note, confidence level, lead ID, status ID, value, value period, and custom fields. The status_id is optional and if omitted, the default status will be used. Custom fields can be set using the custom.FIELD_ID syntax. The response includes details of the created opportunity such as its ID, organization ID, lead ID, status, pipeline, value, confidence, and custom fields.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a new Opportunity Custom Field

  • ID: post_create_opportunity_custom_field
  • Operation: write
  • Entities: custom field, opportunity, organization
  • Summary: This API endpoint allows you to create a new custom field for an opportunity in the Close CRM. The request requires a JSON body with the 'name', 'description', and 'type' of the custom field. The response returns the details of the created custom field, including its unique ID, name, description, type, and metadata such as creation and update timestamps, and the user who created and updated it.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Opportunity Status

  • ID: post_create_opportunity_status
  • Operation: write
  • Entities: pipeline, organization, opportunity status
  • Summary: This API endpoint allows you to create an opportunity status within a specific pipeline. The request requires a JSON body with 'label', 'type', and 'pipeline_id'. The 'type' can be one of 'active', 'won', or 'lost'. The response returns the details of the created opportunity status including its unique ID, label, type, pipeline ID, and organization ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a new OpportunityStatusChange activity

  • ID: post_create_opportunity_status_change_activity
  • Operation: write
  • Entities: opportunity status change, opportunity, lead
  • Summary: This API endpoint allows you to create a new OpportunityStatusChange activity. It logs the status change event in the Lead's activity feed without actually changing the status of the Opportunity. This is useful for importing historical status changes from another organization or system. The request requires a JSON body with the lead_id, opportunity_id, old_status_id, new_status_id, and date_created. The response includes details about the created activity, such as organization_id, created_by, lead_id, new and old status details, opportunity_id, and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create or Activate Membership

  • ID: post_create_or_activate_membership
  • Operation: write
  • Entities: membership, user, organization
  • Summary: This API endpoint creates or activates a membership for a given email. If the user already exists, they are added to the requestor's organization. If not, a new user is provisioned. The request body requires an email and a role_id, which can be 'admin', 'superuser', 'user', 'restricteduser', or a specific role ID. The response includes details about the membership, user, organization, role, onboarding status, permissions granted, and other settings. This request requires 'Manage Organization' permissions and is accessible via OAuth only.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create or Update Third Party Meeting Integration

  • ID: post_create_or_update_third_party_meeting_integration
  • Operation: write
  • Entities: oauth client, meeting, integration
  • Summary: This API endpoint allows the creation or updating of a third-party meeting integration. It requires OAuth authentication and cannot be accessed using an API key. The integration is represented as a tab in the activity feed, titled with the OAuth app name. The request must include the meeting ID in the path and the integration data in the body, specifically the HTML content for the note. The response includes the integration ID, the integration data, the integration name, and details of the OAuth client.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create or Update a User Scheduling Link via OAuth Integration

  • ID: post_create_or_update_user_scheduling_link
  • Operation: write
  • Entities: scheduling link, user, OAuth application
  • Summary: This API endpoint allows OAuth applications to create or update a user scheduling link. The request must be authenticated via OAuth, and using an API key will result in an error. The request body requires parameters such as 'name', 'description', 'url', 'duration_in_minutes', 'source_id', and 'source_type'. If a scheduling link with the specified 'source_id' does not exist, a new one will be created; otherwise, the existing link will be updated. The response includes details of the scheduling link such as 'id', 'name', 'description', 'url', 'duration_in_minutes', 'source_id', 'source_type', and associated user and organization IDs.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Pipeline

  • ID: post_create_pipeline
  • Operation: write
  • Entities: user, pipeline, organization
  • Summary: This API endpoint allows the creation of a new pipeline in the system. The request requires a JSON body with the 'name' of the pipeline. The request headers must include 'Content-Type' and 'Accept' set to 'application/json', and an 'Authorization' header with a Basic authentication API key. The response returns the details of the created pipeline, including its unique ID, name, statuses, creator and updater user IDs, creation and update timestamps, and the associated organization ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Send As Association

  • ID: post_create_send_as_association
  • Operation: write
  • Entities: user, association, organization
  • Summary: This API endpoint creates a 'Send As' association between two users. The 'allowing_user_id' must be equal to your user ID, and it specifies the user who is allowing another user to send as them. The 'allowed_user_id' is the user who is permitted to send as the allowing user. The request requires a JSON body with both user IDs and appropriate headers specifying the content type and accepted response format. The response includes the IDs of both users, the association ID, and the organization ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Sequence

  • ID: post_create_sequence
  • Operation: write
  • Entities: schedule, step, sequence
  • Summary: The 'Create a Sequence' API allows users to create a new sequence with a specified name, schedule, timezone, and steps. The request requires a JSON body containing the sequence name, schedule with weekday ranges and times, timezone, and an array of steps. Each step can include a delay, step type (such as call or email), and optional email template ID and threading options. The response returns the details of the created sequence, including its ID, name, status, schedule, timezone, steps with their respective IDs and details, and metadata such as creation and update timestamps and user IDs.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a new Shared Custom Field

  • ID: post_create_shared_custom_field
  • Operation: write
  • Entities: user, custom field, organization
  • Summary: This API endpoint allows you to create a new shared custom field in the system. The request requires a JSON body with the 'name', 'description', and 'type' of the custom field. The response returns the details of the created custom field, including its unique ID, name, description, type, and metadata such as creation and update timestamps, and the user who created and last updated the field.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Shared Scheduling Link

  • ID: post_create_shared_scheduling_link
  • Operation: write
  • Entities: user, shared scheduling link, organization
  • Summary: This API endpoint allows the creation of a shared scheduling link. It requires a POST request to the specified URL with a JSON body containing 'name' and 'description' fields. The request must include headers for 'Content-Type' and 'Accept' set to 'application/json', and an 'Authorization' header with a basic authentication API key. The response includes details about the created scheduling link, such as its ID, name, description, organization ID, and other metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create an SMS Activity

  • ID: post_create_sms_activity
  • Operation: write
  • Entities: contact, activity, lead
  • Summary: This API endpoint allows you to create an SMS activity. You can specify the status of the SMS, which can be 'inbox', 'draft', 'scheduled', 'outbox', or 'sent'. The request body must include the local phone number used to send the SMS and the remote phone number to which the SMS is sent. Optionally, you can include the text of the SMS, the source, direction, lead ID, and contact ID. The response includes details about the created SMS activity, such as its ID, status, text, phone numbers, direction, and associated user and organization information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create an SMS Template

  • ID: post_create_sms_template
  • Operation: write
  • Entities: sms template, user, organization
  • Summary: This API endpoint allows you to create a new SMS template in the Close application. You need to provide the name, text, and sharing status of the template in the request body. The response includes details about the created template, such as its ID, organization ID, name, text, sharing status, status, and metadata about its creation and updates.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Task

  • ID: post_create_task
  • Operation: write
  • Entities: task, user, lead
  • Summary: The Create a Task API allows users to create a new task of type 'lead'. The request requires a JSON body with fields such as 'lead_id', 'assigned_to', 'text', 'date', and 'is_complete'. The '_type' field is optional and defaults to 'lead'. The response returns the details of the created task, including the task ID, assigned user details, creation and update timestamps, and other metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a User Scheduling Link

  • ID: post_create_user_scheduling_link
  • Operation: write
  • Entities: scheduling link, user, organization
  • Summary: This API endpoint allows the creation of a user scheduling link. It requires a POST request to the specified URL with a JSON body containing the 'name', 'description', and 'url' of the scheduling link. The request headers must include 'Content-Type' and 'Accept' set to 'application/json'. The response includes details of the created scheduling link such as 'id', 'name', 'description', 'url', 'organization_id', 'user_id', and other metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Edit Send As Associations in Bulk

  • ID: post_edit_send_as_associations_in_bulk
  • Operation: write
  • Entities: user, association, organization
  • Summary: The 'Edit Send As Associations in Bulk' API allows you to manage send as permissions for multiple users in a single request. By providing lists of user IDs to allow and disallow, you can control who can send emails on your behalf. The request requires a JSON body with 'allowed_user_ids' and 'disallowed_user_ids'. The response returns all existing associations where your user is the allowing user, including details such as allowed user ID, allowing user ID, association ID, and organization ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Export Leads, Opportunities, or Contacts

  • ID: post_export_leads_opportunities_contacts
  • Operation: write
  • Entities: contact, opportunity, lead
  • Summary: This API endpoint allows users to export leads, opportunities, or contacts based on a lead search query. The export can be in CSV or JSON format, and users will receive a link to the generated file via email once the export is complete. The exported file is GZIP compressed for faster download and upload. Users can specify various parameters such as the format, type of export, fields to include, and whether to include activities or smart fields. The API also allows users to set whether they want to receive a confirmation email after the export is done.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Log a Call Activity Manually

  • ID: post_log_a_call_activity_manually
  • Operation: write
  • Entities: call, contact, lead
  • Summary: The 'Log a Call Activity Manually' API allows users to log call activities that were made outside of the Close VoIP system. This API endpoint requires a POST request to 'https://api.close.com/api/v1/activity/call/' with necessary headers and a JSON body containing details such as 'lead_id', 'contact_id', 'created_by', 'user_id', 'direction', 'status', 'note_html', 'duration', and 'phone'. The 'direction' and 'status' fields are optional, with 'status' defaulting to 'completed'. The response includes details of the logged call activity, such as 'id', 'organization_id', 'date_created', 'created_by', 'lead_id', 'contact_id', 'direction', 'duration', and more. This API is useful for tracking call activities that are not automatically logged by the system.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Bulk Update Memberships

  • ID: put_bulk_update_memberships
  • Operation: write
  • Entities: membership, role
  • Summary: The Bulk Update Memberships API allows users to update multiple membership records at once by specifying their IDs in a comma-separated format. The request requires a JSON body with '_params' containing 'id__in' for membership IDs and 'role_id' for the new role to be assigned. The response returns the count of memberships that were successfully updated.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Bulk Update Tasks

  • ID: put_bulk_update_tasks
  • Operation: write
  • Entities: task
  • Summary: The Bulk Update Tasks API allows users to update multiple tasks at once by specifying task IDs in the request body. The API supports updating the 'assigned_to', 'date', and 'is_complete' fields of the tasks. The request must include the 'Content-Type' and 'Accept' headers set to 'application/json', and an authorization token. The response indicates whether the operation was successful.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Call Activity

  • ID: put_update_a_call_activity
  • Operation: write
  • Entities: activity, call, note
  • Summary: The 'Update a Call Activity' API allows users to update the details of a call activity, specifically the 'note_html' field. This API is accessed via a PUT request to the endpoint 'https://api.close.com/api/v1/activity/call/{id}/', where '{id}' is the unique identifier of the call activity. The request must include headers specifying 'Content-Type' and 'Accept' as 'application/json'. The request body should contain the 'note_html' field with the new HTML content for the call note. The response includes detailed information about the call activity, such as its ID, type, direction, disposition, source, note content, duration, phone numbers, and associated user, lead, and contact IDs. Some fields, like status, duration, or direction, cannot be updated for internal calls made through Close's VoIP system.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Task

  • ID: put_update_a_task
  • Operation: write
  • Entities: lead, task, user
  • Summary: The 'Update a Task' API allows users to update specific fields of a task identified by its unique ID. The fields that can be updated include 'assigned_to', 'date', and 'is_complete'. If the task type is 'lead', the 'text' field can also be modified. The API requires the task ID as a path parameter and the 'is_complete' status as part of the request body. The response includes detailed information about the task, such as its type, assigned user, creation and update timestamps, and associated lead and organization details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update an Email Activity

  • ID: put_update_an_email_activity
  • Operation: write
  • Entities: activity, email, user
  • Summary: The 'Update an Email Activity' API allows users to modify the details of an existing email activity, such as updating the subject of a draft email. The API requires the email activity ID as a path parameter and the updated subject in the request body. The request must include 'Content-Type' and 'Accept' headers set to 'application/json'. Upon successful update, the API returns detailed information about the email activity, including its ID, type, associated contact and user IDs, email addresses involved, subject, body content, and status. This API is useful for managing email drafts and sending them once they are complete.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update an Opportunity

  • ID: put_update_an_opportunity
  • Operation: write
  • Entities: custom field, opportunity, status
  • Summary: The 'Update an Opportunity' API allows you to update the details of an existing opportunity by specifying the opportunity ID in the path parameters. The request requires headers for content type and accept, and optionally a timezone offset. The body must include a status_id to update the opportunity's status, and optionally a date_won and custom fields. The response returns the updated opportunity details, including IDs, names, status, pipeline, value, and timestamps.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update an Existing Contact

  • ID: put_update_existing_contact
  • Operation: write
  • Entities: contact, custom field, phone
  • Summary: The 'Update an Existing Contact' API allows you to update the details of an existing contact in the system. You can update basic information such as the contact's name, as well as custom fields. If a custom field accepts multiple values, you can use the .add or .remove suffix to modify the list of values. The API requires the contact's unique identifier in the path parameters and accepts a JSON request body with the fields to be updated. The response includes the updated contact details, including identifiers, name, title, contact information, and custom fields.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update an Existing Lead

  • ID: put_update_existing_lead
  • Operation: write
  • Entities: contact, custom field, lead
  • Summary: The 'Update an Existing Lead' API allows you to update the details of an existing lead using a PUT request. The API supports non-destructive patches, meaning you can update specific fields without affecting others. You can update the lead's description and custom fields, including adding or removing values from fields that accept multiple values. The request requires the lead's unique identifier in the path parameters and accepts a JSON body with the fields to be updated. The response returns the updated lead details, including status, contacts, and other metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated about 1 month ago