freshworks API Integration

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

Delete a Contact

ID: delete_a_contact
Operation: write
Entities: contact
Summary: This API allows you to delete a contact by specifying the contact's ID in the URL path. It requires an authorization token in the headers for authentication. The request must include the 'Content-Type' header set to 'application/json'. Upon successful deletion, the API returns a boolean value 'true'.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Deal

ID: delete_a_deal
Operation: write
Entities: deal
Summary: This API allows you to delete a deal by specifying the deal ID in the URL path. It requires an authorization token in the headers for authentication. The request must include the 'Content-Type' header set to 'application/json'. Upon successful deletion, the API returns a boolean value 'true' indicating the deal was deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Document

ID: delete_a_document
Operation: write
Entities: document
Summary: This API allows you to delete a document by specifying its ID in the path parameters. The request requires an authorization token in the headers. Upon successful deletion, the API returns a response with the ID of the deleted document and a success code.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Note

ID: delete_a_note
Operation: write
Entities: note
Summary: This API allows you to delete a note by specifying the note ID in the URL path. It requires an authorization token in the headers for access. The response includes details of the deleted note, such as its ID, description, creation timestamp, and last update timestamp.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Product

ID: delete_a_product
Operation: write
Entities: product
Summary: This API allows you to delete a product by specifying the product ID in the URL path. It requires an authorization token in the headers. The response includes a message with the ID of the deleted product and a status code indicating the success of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an Account

ID: delete_an_account
Operation: write
Entities: deal, contact, account
Summary: This API allows you to delete an account by specifying the account ID in the path parameters. The request requires an Authorization token and a Content-Type header. Optionally, you can include a query parameter 'delete_associated_contacts_deals' to also delete associated contacts and open deals. The response is a boolean indicating whether the account was successfully deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an Appointment

ID: delete_an_appointment
Operation: write
Entities: appointment
Summary: This API allows you to delete an appointment by specifying the appointment ID in the URL path. It requires an Authorization token in the headers for authentication and a Content-Type header set to application/json. The response indicates the success of the operation with a success message.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Custom Module

ID: delete_custom_module
Operation: write
Entities: custom module, setting, module customization
Summary: The Delete Custom Module API allows users to delete a specific custom module by providing its ID in the URL path. The request requires an authorization token in the headers for authentication and a content type of 'application/json'. Upon successful deletion, the API returns a confirmation message in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Forget a Contact

ID: delete_forget_a_contact
Operation: write
Entities: contact, data
Summary: The 'Forget a Contact' API allows you to permanently delete a contact and all associated data from the system. This is done by sending a DELETE request to the endpoint '/api/contacts/[id]/forget' with the contact's ID specified in the path parameters. The request must include an 'Authorization' header with a valid token and a 'Content-Type' header set to 'application/json'. If successful, the API returns a boolean value 'true' indicating that the contact has been forgotten.
Input Fields: Input Fields
Output Fields: Output Fields

Forget a Deal

ID: delete_forget_a_deal
Operation: write
Entities: deal, data
Summary: The 'Forget a Deal' API allows you to permanently delete a deal and all associated data from the system. This is done by sending a DELETE request to the endpoint '/api/deals/[id]/forget' with the deal ID specified in the path parameters. The request must include an 'Authorization' header with a valid token and a 'Content-Type' header set to 'application/json'. If successful, the API returns a boolean 'true' indicating that the deal has been forgotten.
Input Fields: Input Fields
Output Fields: Output Fields

Forget a Document

ID: delete_forget_a_document
Operation: delete
Entities: data, document
Summary: The 'Forget a Document' API allows you to permanently delete a document and all associated data. It requires a DELETE request to the endpoint with the document ID specified in the path. The request must include an Authorization header with a valid token and a Content-Type header set to 'application/json'. Upon successful deletion, the API returns a response with the ID of the forgotten document and a success code.
Input Fields: Input Fields
Output Fields: Output Fields

Forget an Account

ID: delete_forget_an_account
Operation: write
Entities: account, data
Summary: The 'Forget an Account' API allows you to permanently delete an account and all associated data. This is done by sending a DELETE request to the specified endpoint with the account ID in the path. The request must include an Authorization token and specify the Content-Type as application/json. The response will be a boolean value indicating whether the account was successfully forgotten.
Input Fields: Input Fields
Output Fields: Output Fields

Forget a Record in Custom Module

ID: delete_forget_record_in_custom_module
Operation: delete
Entities: custom module, loan
Summary: The 'Forget a Record in Custom Module' API allows you to permanently delete a record from a specified custom module, such as 'Loans'. This is done by sending a DELETE request to the endpoint with the entity name and record ID in the path parameters. The request must include an authorization token in the headers. If successful, the API returns a boolean value 'true', indicating that the record has been permanently forgotten.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Record in Custom Module

ID: delete_record_in_custom_module
Operation: write
Entities: custom module, loan, record
Summary: This API allows you to delete a record from a custom module in the Freshworks CRM. To use this API, you need to specify the entity name and the ID of the record you wish to delete in the URL path parameters. The request must include an Authorization header with a valid token and a Content-Type header set to application/json. Upon successful deletion, the API returns a confirmation message indicating that the record has been deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Sales Activity

ID: delete_sales_activity
Operation: write
Entities: sales activity
Summary: This API allows you to delete a sales activity by specifying the sales activity ID in the path parameters. The request requires an authorization token in the headers. Upon successful deletion, the API returns a response indicating success with a status code of 200.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Task

ID: delete_task
Operation: write
Entities: task
Summary: The Delete Task API allows you to delete a specific task by providing the task ID in the URL path. It requires an authorization token in the headers for authentication. The response includes details of the deleted task such as its ID, status, title, description, creation and update timestamps, owner ID, due date, and creator ID.
Input Fields: Input Fields
Output Fields: Output Fields

Fetch All Contacts from the List

ID: get_all_contacts_from_list
Operation: read
Entities: contact, marketing list
Summary: This API allows you to fetch all the contacts from a specific marketing list identified by its unique ID. The request is made using the GET method to the endpoint '/api/contacts/lists/[id]', where '[id]' is the unique identifier of the marketing list. The request requires an 'Authorization' header with a token and a 'Content-Type' header set to 'application/json'. The response includes a list of contacts with detailed information such as contact ID, name, email, phone numbers, and other attributes. The response also includes metadata about the total number of contacts and pages.
Input Fields: Input Fields
Output Fields: Output Fields

Fetch All Marketing Lists

ID: get_fetch_all_marketing_lists
Operation: read
Entities: list, meta
Summary: This API endpoint allows you to fetch all the marketing lists that have been created. It requires an authorization token to access. The request must include the 'Authorization' header with a valid token and the 'Content-Type' header set to 'application/json'. The response includes an array of marketing lists, each with a unique 'id' and 'name'. Additionally, the response provides metadata indicating the total number of pages and the total number of lists available.
Input Fields: Input Fields
Output Fields: Output Fields

List All Appointments

ID: get_filtered_appointments
Operation: read
Entities: appointment, user
Summary: The List All Appointments API allows users to retrieve a list of appointments based on a specified filter. The filter parameter is mandatory and only one filter can be applied at a time. Users can also include additional details in the response by using the 'include' query parameter with values such as 'creater', 'targetable', or 'appointment_attendees'. The response includes details about users and appointments, such as user ID, display name, email, appointment ID, time zone, title, description, location, and more. The API requires an authorization token and content type header for access.
Input Fields: Input Fields
Output Fields: Output Fields

Job Status Tracking API

ID: get_job_status_tracking
Operation: read
Entities: record status, job type, job status
Summary: The Job Status Tracking API allows users to track the progress and details of a background job by providing the job ID. It supports bulk upsert jobs only. The API requires an authorization token and content type in the headers. The response includes the job's current status, job type name, creation and status update timestamps, progress percentage, and a detailed report on the records processed, including the number of succeeded and failed records and reasons for any failures.
Input Fields: Input Fields
Output Fields: Output Fields

List All Account Fields

ID: get_list_all_account_fields
Operation: read
Entities: field, sales account, field group
Summary: The 'List All Account Fields' API allows users to retrieve all the fields associated with sales accounts. The API requires authorization via an API token and accepts an optional query parameter 'include' to include field groups in the response. The response contains an array of field objects, each with details such as id, label, name, type, default status, actionable status, position, choices, base model, and whether the field is required.
Input Fields: Input Fields
Output Fields: Output Fields

List All Accounts

ID: get_list_all_accounts
Operation: read
Entities: view, account, filter
Summary: The 'List All Accounts' API allows users to fetch a list of sales accounts by specifying a view ID. If the view ID is not provided, all accounts are retrieved. The API requires an authorization token and content type in the headers. The view ID is a path parameter that determines which accounts to fetch. Additionally, a query parameter 'include' can be used to embed additional details in the response, such as the owner. The response includes a list of sales accounts with comprehensive details such as ID, name, address, city, state, country, number of employees, annual revenue, website, owner ID, phone, open deals amount, and more. Metadata about the total number of pages and accounts is also provided. Users can filter accounts using views and sort them by various fields such as open deals amount, creation date, last contacted date, etc.
Input Fields: Input Fields
Output Fields: Output Fields

List all Activities

ID: get_list_all_activities
Operation: read
Entities: user, contact, activity
Summary: This API retrieves the activities associated with a specific contact. It requires the contact ID as a path parameter. The request must include an authorization token in the headers. Optional query parameters include 'include' to embed additional details such as user information, and 'limit' to restrict the number of results returned. The response includes a list of users and activities, with each activity containing details such as composite ID, action data, action type, creation date, and associated user information.
Input Fields: Input Fields
Output Fields: Output Fields

List All Contact Fields

ID: get_list_all_contact_fields
Operation: read
Entities: field, contact, field group
Summary: This API allows you to list all contact fields available in the system. It requires authorization via an API token or username/password. The API supports an optional query parameter 'include' to include field groups in the response. The response contains an array of field objects, each with details such as id, label, name, type, default status, actionable status, position, choices, base model, and whether the field is required.
Input Fields: Input Fields
Output Fields: Output Fields

List All Contacts

ID: get_list_all_contacts
Operation: read
Entities: contact, filter
Summary: The List All Contacts API allows users to fetch a list of contacts from a specified view. The API requires an authorization token and content type in the headers. The view_id path parameter is optional; if not specified, all accounts are retrieved. The query parameter 'include' can be used to embed additional details in the response. The response includes an array of contact objects, each containing details such as job title, email, phone numbers, and timestamps for creation and last update. The response also includes metadata indicating the total number of contacts returned.
Input Fields: Input Fields
Output Fields: Output Fields

List All Deal Fields

ID: get_list_all_deal_fields
Operation: read
Entities: field, deal, group
Summary: The 'List All Deal Fields' API allows users to retrieve all the deal fields available in the system. It supports an optional query parameter 'include' to include field groups in the response. The API requires authorization via an API token or username/password. The response includes details about each field such as its ID, label, name, type, default status, whether it is actionable, its position, choices available (if any), base model, and whether it is required.
Input Fields: Input Fields
Output Fields: Output Fields

List All Deals

ID: get_list_all_deals
Operation: read
Entities: view, deal, filter
Summary: The 'List All Deals' API allows users to fetch a list of deals from a specified view. To use this API, you must first obtain a view ID using the Filters API. The API requires an authorization token and content type in the headers. The view ID is a path parameter and is optional; if not provided, all accounts are retrieved. The query parameter 'include' can be used to embed additional details in the response. The response includes a list of deals with comprehensive details such as deal ID, name, amount, probability, custom fields, links, products, and metadata indicating the total number of deals.
Input Fields: Input Fields
Output Fields: Output Fields

List all Files and Links

ID: get_list_all_files_and_links
Operation: read
Entities: document link, contact, document
Summary: The 'List all Files and Links' API allows you to retrieve all files and document links associated with a specific contact in the Freshworks CRM. The API requires an authorization token in the header and the contact ID as a path parameter. The response includes details about users, documents, and document links associated with the contact. Each document and link includes metadata such as ID, URL, name, shared status, and creation timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

List All Sales Activities

ID: get_list_all_sales_activities
Operation: read
Entities: contact, sales activity
Summary: This API allows you to list all the sales activities. It requires an Authorization token in the headers and supports optional query parameters for pagination such as 'page' and 'per_page'. The response includes a list of sales activities with details such as id, title, start and end dates, type, owner, location, and custom fields. The meta information provides the total number of pages and total sales activities.
Input Fields: Input Fields
Output Fields: Output Fields

List All Sales Activity Fields

ID: get_list_all_sales_activity_fields
Operation: read
Entities: field, group, sales activity
Summary: This API allows you to view the list of sales activity fields along with their groups they belong to. It requires an authorization token in the headers and optionally accepts a query parameter 'include' to include field groups. The response includes a list of fields with details such as id, label, name, type, default status, actionable status, position, choices, base model, required status, quick add position, visibility, and auto-suggest URL.
Input Fields: Input Fields
Output Fields: Output Fields

List All Tasks

ID: get_list_all_tasks
Operation: read
Entities: owner, user, task
Summary: The 'List All Tasks' API allows users to retrieve a list of tasks based on a specified filter. The filter parameter is mandatory and only one filter can be applied at a time. Additional details such as users, targetable, and owner can be embedded in the response using the 'include' query parameter. The API requires an authorization token and content type header. The response includes details about users and tasks, along with metadata indicating the total number of tasks.
Input Fields: Input Fields
Output Fields: Output Fields

Get a list of all fields in a custom module

ID: get_list_of_all_fields_in_a_custom_module
Operation: read
Entities: custom module, form, field
Summary: This API endpoint allows you to fetch a list of all fields in a specified custom module. The request requires an authorization token and the content type to be specified in the headers. The entity type for which the fields are being fetched must be provided as a path parameter. The response includes a list of forms, each containing details about the form and its fields, such as field ID, name, label, type, and various options. The response also includes metadata about the latest version data of the forms.
Input Fields: Input Fields
Output Fields: Output Fields

Get a list of custom modules

ID: get_list_of_custom_modules
Operation: read
Entities: layout customization, module customization, config
Summary: This API fetches a list of all the custom modules created by the user. It requires an authorization token and content type in the headers. The path parameter 'id' is required to specify the custom module ID. The response includes details about the module such as its singular and plural names, entity name, description, icon, position, navigation visibility, customization status, resource path, layout customizations, status, creation and update timestamps, and configuration settings.
Input Fields: Input Fields
Output Fields: Output Fields

Lookup Search API

ID: get_lookup_search
Operation: read
Entities: contact, deal, sales account
Summary: The Lookup Search API allows users to search for records by name or email address. It requires three mandatory query parameters: 'q' for the search query, 'f' for the field to search against, and 'entities' for the entities to search within. The API only returns exact matches for the search query. It supports searching across multiple entities if the field is available in all specified entities. The response includes detailed information about the contacts that match the search criteria, including personal details, company information, and custom fields.
Input Fields: Input Fields
Output Fields: Output Fields

View Product Details

ID: get_product_details
Operation: read
Entities: product, product pricing, custom field
Summary: This API allows you to view the details of a product by providing the product ID in the path parameters. You can include additional details such as 'product_pricings' in the query parameters to get configured prices of the products. The request requires an authorization token in the headers. The response includes detailed information about the product, including its ID, name, category, custom fields, product code, SKU number, pricing details, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Fetch Records from a Specific View in a Custom Module

ID: get_records_from_specific_view
Operation: read
Entities: custom module, loan, filter
Summary: This API allows you to fetch records from a specific view within a custom module in the CRM. To use this API, you need to first determine the internal name of the module and the ID of the view you wish to access. The API requires an authorization token and content type in the headers. The response includes a list of records with details such as ID, name, custom fields, creation and update timestamps, and links to associated documents and notes. The meta information provides pagination details and avatar data.
Input Fields: Input Fields
Output Fields: Output Fields

Get Related Products

ID: get_related_products
Operation: read
Entities: product, document, pricing
Summary: The Get Related Products API allows users to retrieve a list of products associated with a specific document. The API requires an authorization token and content type in the headers. The document ID is specified as a path parameter. The response includes a list of related products, each with details such as product ID, name, category, custom fields, product code, SKU number, parent product, territory ID, validity date, active status, owner ID, deletion status, creation and update timestamps, pricing type, product pricing details, avatar, base currency amount, creator and updater IDs, description, and lookup information.
Input Fields: Input Fields
Output Fields: Output Fields

View a Sales Activity

ID: get_sales_activity
Operation: read
Entities: contact, custom field, sales activity
Summary: This API allows you to view a specific sales activity by its ID. It requires an authorization token and content type in the headers. The sales activity ID is a required path parameter. The response includes detailed information about the sales activity, such as its title, start and end dates, type ID, creation and update timestamps, owner ID, location details, and custom fields.
Input Fields: Input Fields
Output Fields: Output Fields

View Task Details

ID: get_task_details
Operation: read
Entities: contact, user, task
Summary: This API allows you to view the details of a specific task by providing the task ID in the path parameters. You can optionally include additional details such as users and targetable entities in the response by using the 'include' query parameter. The response includes detailed information about the task, associated users, and contacts. The request requires an authorization token in the headers.
Input Fields: Input Fields
Output Fields: Output Fields

View a Contact

ID: get_view_a_contact
Operation: read
Entities: contact, deal, sales activity
Summary: The 'View a Contact' API allows users to retrieve detailed information about a specific contact by providing the contact's ID. The API supports the GET method and requires an authorization token in the headers. Users can optionally include additional details in the response by using the 'include' query parameter, which supports values such as 'sales_activities', 'owner', 'creater', 'updater', 'source', 'campaign', 'tasks', 'appointments', 'notes', 'deals', 'sales_accounts', 'territory', and 'sales_account'. The response includes comprehensive contact details such as name, contact information, lead score, and associated sales accounts.
Input Fields: Input Fields
Output Fields: Output Fields

View a Document

ID: get_view_a_document
Operation: read
Entities: product, deal, cpq document
Summary: This API allows you to view the details of a document by providing the document ID in the path parameters. The request requires an authorization token in the headers. You can optionally include additional details such as products in the response by using the 'include' query parameter. The response contains detailed information about the document, including its ID, type, stage, validity, addresses, owner, amount, currency, and associated products if requested.
Input Fields: Input Fields
Output Fields: Output Fields

View an Account

ID: get_view_an_account
Operation: read
Entities: deal, contact, account
Summary: This API allows you to view the details of a sales account by providing the account ID. It supports embedding additional details in the response using the 'include' query parameter. The API requires an authorization token in the headers. The response includes user details and sales account information such as name, address, number of employees, annual revenue, and more. Optional embedded details include owner, creater, updater, territory, business type, tasks, appointments, contacts, deals, industry type, and child sales accounts.
Input Fields: Input Fields
Output Fields: Output Fields

View an Appointment

ID: get_view_an_appointment
Operation: read
Entities: contact, appointment, user
Summary: This API allows you to view the details of a specific appointment by providing the appointment ID in the path parameters. The request requires an authorization token in the headers. The response includes detailed information about the appointment, such as the attendees, users, contacts, and appointment details including title, description, location, and time details.
Input Fields: Input Fields
Output Fields: Output Fields

View Deal Details

ID: get_view_deal_details
Operation: read
Entities: deal, contact, account
Summary: The View Deal Details API allows users to retrieve detailed information about a specific deal using its unique identifier. The API supports the GET method and requires an authorization token in the headers. Users can specify the deal ID in the path parameters and optionally include additional details such as sales activities, owner, creater, updater, source, contacts, sales account, deal stage, deal type, deal reason, campaign, deal payment status, deal product, and currency in the query parameters. The response includes user details and comprehensive deal information, including the deal's name, amount, base currency amount, stage updated time, custom fields, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Assign Owner to Contacts

ID: post_bulk_assign_owner_to_contacts
Operation: write
Entities: contact, owner
Summary: This API allows you to bulk assign an owner to a list of contacts. You need to provide an array of contact IDs in the 'selected_ids' field and the 'owner_id' of the user to be assigned as the owner. The request must include an authorization token in the headers. The response returns an array of objects indicating whether the owner was successfully assigned to each contact.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk-assign Owner to Documents

ID: post_bulk_assign_owner_to_documents
Operation: write
Entities: user, document, owner
Summary: This API allows you to bulk-assign an owner to a list of documents. You need to provide an array of document IDs ('selected_ids') and the 'owner_id' of the user to whom the documents will be assigned. The request must include an authorization token in the headers. Upon successful request, the API returns a message indicating that the sales owner assignment has been added to the queue and you will be notified upon success.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk-assign Owner to Products

ID: post_bulk_assign_owner_to_products
Operation: write
Entities: assignment, product, owner
Summary: The Bulk-assign Owner to Products API allows you to assign a sales owner to a list of products by providing an array of product IDs and the user ID of the owner. The request requires an authorization token and must be in JSON format. Upon successful request, the API returns a message indicating that the sales owner assignment has been added to a queue and that you will be notified upon success.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Delete Accounts

ID: post_bulk_delete_accounts
Operation: write
Entities: deal, contact, account
Summary: The Bulk Delete Accounts API allows users to delete multiple sales accounts at once. The request requires an authorization token and a content type header. The body of the request must include an array of account IDs to be deleted. Optionally, users can specify whether to delete associated contacts and open deals by setting the 'delete_associated_contacts_deals' parameter to true. The response returns an array indicating the success of the deletion for each account ID.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Delete Contacts

ID: post_bulk_delete_contacts
Operation: write
Entities: contact
Summary: The Bulk Delete Contacts API allows users to delete multiple contacts at once by providing an array of contact IDs. The request requires an authorization token and must specify the content type as JSON. The response returns an array of objects indicating whether each contact ID was successfully deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Delete Deals

ID: post_bulk_delete_deals
Operation: write
Entities: deal
Summary: The Bulk Delete Deals API allows users to delete multiple deals at once by providing an array of deal IDs. The request requires an authorization token and must specify the content type as JSON. The response returns an array of objects indicating whether each deal ID was successfully deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk-delete Documents

ID: post_bulk_delete_documents
Operation: write
Entities: document
Summary: The Bulk-delete Documents API allows users to delete multiple documents at once by providing an array of document IDs. The request requires an authorization token and must specify the content type as JSON. Upon successful request, the API returns a message indicating that the bulk deletion has been added to the queue and that the user will be notified upon success.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk-delete Products

ID: post_bulk_delete_products
Operation: write
Entities: product
Summary: The Bulk-delete Products API allows users to delete multiple products at once by providing an array of product IDs. The request requires an authorization token and must specify the content type as JSON. The response confirms that the bulk deletion has been queued and that the user will be notified upon successful completion.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk-delete Records in Custom Module

ID: post_bulk_delete_records_in_custom_module
Operation: write
Entities: custom module, property, loan
Summary: This API allows for the bulk deletion of records in a specified custom module, such as 'Loans'. The endpoint requires the entity name of the custom module and a list of record IDs to be deleted. The request must include an authorization token and specify the content type as JSON. Upon successful deletion, the API returns a message indicating the number of records that were deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk-restore Documents

ID: post_bulk_restore_documents
Operation: write
Entities: document
Summary: The Bulk-restore Documents API allows users to restore deleted documents in bulk by providing an array of document IDs. The API requires an authorization token and content type in the headers. The request body must include 'selected_ids', an array of numbers representing the IDs of the documents to be restored. Upon successful initiation, the API returns a message confirming that the restoration process has started and that a notification will be sent upon completion.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk-restore Products

ID: post_bulk_restore_products
Operation: write
Entities: product
Summary: The Bulk-restore Products API allows users to restore deleted products in bulk. It requires a POST request to the specified endpoint with an authorization token and a JSON body containing an array of product IDs to be restored. The API responds with a message confirming that the restoration process has started and that a notification will be sent upon completion.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Upsert Account

ID: post_bulk_upsert_account
Operation: write
Entities: sales account, job status
Summary: The Bulk Upsert Account API allows users to create or update multiple sales accounts in a single request. The API endpoint is POST /api/sales_accounts/bulk_upsert. Users must provide an authorization token and specify the content type as application/json in the headers. The request body should contain an array of sales account objects, each with a unique identifier and associated data. A maximum of 100 entities can be processed per request, and up to 10 concurrent requests are allowed. The response includes a message indicating the initiation of the batch job and a URL to track the job's status.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Upsert Contact

ID: post_bulk_upsert_contact
Operation: write
Entities: contact, job status, unique identifier
Summary: The Bulk Upsert Contact API allows users to create or update multiple contacts in bulk. It accepts a POST request at the endpoint /api/contacts/bulk_upsert with a JSON body containing an array of contact objects. Each contact object must include a unique identifier and a data hash with contact properties. The API supports a maximum of 10 concurrent in-progress requests and can handle up to 100 entities per request. The response includes a message indicating the initiation of the batch job and a URL to track the job's status.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Upsert Deal

ID: post_bulk_upsert_deal
Operation: write
Entities: deal, job status
Summary: The Bulk Upsert Deal API allows users to create or update multiple deals in bulk. The API endpoint is POST /api/deals/bulk_upsert. Users must provide an authorization token and specify the content type as application/json in the headers. The request body should contain an array of deal objects, each with a unique identifier and associated data. A maximum of 10 concurrent bulk-upsert API calls can be made from an account, and up to 100 entities can be processed in a single request. The response includes a message indicating the initiation of the batch job and a URL to track the job's status.
Input Fields: Input Fields
Output Fields: Output Fields

Clone a Contact

ID: post_clone_a_contact
Operation: write
Entities: contact, custom field, link
Summary: The Clone a Contact API allows users to clone an existing contact by sending a POST request to the specified endpoint. The request requires an authorization token and content type in the headers. The contact ID to be cloned is specified in the path parameters. The request body can optionally include contact details to override in the cloned contact. The response returns the details of the cloned contact, including its ID, name, mobile number, and other attributes.
Input Fields: Input Fields
Output Fields: Output Fields

Clone a Deal

ID: post_clone_a_deal
Operation: write
Entities: deal, custom field, user
Summary: The Clone a Deal API allows users to clone an existing deal by sending a POST request to the specified endpoint. The request requires an authorization token and content type in the headers. The deal ID to be cloned is specified in the path parameters. The request body can optionally include properties for the new deal, such as name, amount, and sales account ID. The response includes details of the users associated with the deal and the cloned deal's information, including its ID, name, amount, and other attributes.
Input Fields: Input Fields
Output Fields: Output Fields

Clone an Account

ID: post_clone_an_account
Operation: write
Entities: account, custom field, link
Summary: The Clone an Account API allows you to clone an existing sales account by making a POST request to the specified endpoint. The API requires an authorization token and content type in the headers. The path parameter 'id' specifies the sales account to be cloned. The request body can optionally include properties for the new account, such as 'name'. The response includes details of the cloned sales account, such as 'id', 'name', 'address', and other attributes. By default, all properties of the existing account are copied to the new account unless specified otherwise in the request body.
Input Fields: Input Fields
Output Fields: Output Fields

Clone a Custom Module Record

ID: post_clone_custom_module_record
Operation: write
Entities: custom module, loan, field
Summary: This API allows you to clone a record from a custom module, such as 'Loans'. The endpoint requires the entity name and the ID of the record to be cloned. The request must include an authorization token and specify the content type as JSON. The body of the request should contain the name and owner_id fields, which are default fields in all custom modules, along with any custom fields. The response returns the details of the cloned record, including its ID, name, owner ID, custom fields, creation and update timestamps, and links to associated documents and notes.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Contact

ID: post_create_a_contact
Operation: write
Entities: contact, account, custom field
Summary: This API allows you to create a contact in the system. It requires an authorization token and content type in the headers. The request body must include the contact's first name, last name, and mobile number. Optional fields include email, job title, owner ID, address, city, state, zipcode, country, custom fields, and sales accounts. The response returns the contact's details, including ID, name, mobile number, and links to related conversations and activities.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Deal

ID: post_create_a_deal
Operation: write
Entities: deal, custom field, user
Summary: The 'Create a Deal' API allows users to create a new deal in the system. The API endpoint is accessed via a POST request to 'https://domain.myfreshworks.com/crm/sales/api/deals'. The request must include headers for authorization and content type. The body of the request should contain a 'deal' object with required fields such as 'name' and 'amount', and optional fields like 'owner_id', 'sales_account_id', 'deal_stage_id', 'deal_pipeline_id', 'custom_field', 'sales_account', and 'contacts_added_list'. The response includes details of the created deal and associated users, with fields such as 'id', 'name', 'amount', 'stage_updated_time', and 'created_at'.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Document

ID: post_create_a_document
Operation: write
Entities: product, custom field, cpq document
Summary: This API allows you to create a document in the CPQ system. It requires an authorization token and content type in the headers. The request body must include details such as deal ID, sales account ID, contact ID, document type, stage, validity date, shipping and billing addresses, amount, display name, currency code, owner ID, territory ID, and template name. Custom fields can also be included optionally. The response returns the created document's details, including its ID, deal ID, contact ID, sales account ID, document type, stage, validity date, addresses, amount, currency code, owner ID, territory ID, and other metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Link

ID: post_create_a_link
Operation: write
Entities: deal, contact, account
Summary: The 'Create a Link' API allows users to attach links of files to a contact, sales account, or a deal in the CRM system. The API requires an authorization token and content type in the headers. The request body must include the URL of the file, a boolean indicating if the link is shared, the ID and type of the target entity, and the name of the link. Upon successful execution, the API returns the ID of the created document link, a success message, and the URL of the linked document.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Marketing List

ID: post_create_a_marketing_list
Operation: write
Entities: list
Summary: This API allows you to create a marketing list by sending a POST request to the specified endpoint. The request must include an Authorization token in the headers and the Content-Type set to application/json. The body of the request should contain the 'name' of the marketing list to be created. Upon successful creation, the API returns the details of the created list, including its unique 'id' and 'list_name'.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Note

ID: post_create_a_note
Operation: write
Entities: contact, deal, note
Summary: This API allows you to create a note for a specific entity such as a Contact, SalesAccount, or Deal. The request requires an Authorization token and a Content-Type header set to application/json. The body of the request must include a note object with a description, targetable_type, and targetable_id. The response returns the created note's ID, description, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Product

ID: post_create_a_product
Operation: write
Entities: product, owner, category
Summary: This API allows you to create a product in the system. It requires an authorization token and content type in the headers. The request body must include details about the product such as name, description, category, status, parent product ID, product code, SKU number, validity date, and owner ID. Optionally, custom fields can be added. The response returns the created product's details including its ID, name, category, product code, SKU number, parent product ID, validity date, status, owner ID, creation and update timestamps, and other metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Account

ID: post_create_an_account
Operation: write
Entities: parent account, account, custom field
Summary: This API allows you to create a sales account in the system. It requires an authorization token and content type in the headers. The request body must include the 'sales_account' object with a mandatory 'name' field. Optional fields include 'owner_id', 'address', 'city', 'state', 'country', 'zipcode', 'number_of_employees', 'phone', 'website', and 'custom_field' for additional custom data. The response returns the details of the created sales account, including its ID, name, and various optional fields such as address, city, and custom fields.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Appointment

ID: post_create_an_appointment
Operation: write
Entities: contact, appointment, user
Summary: This API allows you to create an appointment by sending a POST request to the specified endpoint. The request must include headers for authorization and content type, and a JSON body containing details of the appointment such as title, description, start and end dates, time zone, location, targetable ID and type, and a list of attendees. The response includes details of the created appointment, including its ID, time zone, title, description, location, start and end dates, latitude, longitude, and a list of attendee IDs, along with details of the users and contacts involved.
Input Fields: Input Fields
Output Fields: Output Fields

Create Custom Field

ID: post_create_custom_field
Operation: write
Entities: custom module, form, field
Summary: The Create Custom Field API allows users to add various types of fields to custom modules, such as dropdowns, radio buttons, checkboxes, or lookup fields. The API requires the entity type and form ID as path parameters. The request body must include a unique label and type for the field, while other parameters like hint, internal name, editable, visible, required, and parent_id are optional. The response provides detailed information about the newly created field, including its ID, label, type, position, and various options and settings.
Input Fields: Input Fields
Output Fields: Output Fields

Create Custom Modules

ID: post_create_custom_modules
Operation: write
Entities: custom module, module customization, layout customization
Summary: This API allows you to create a custom module in the system. It requires the singular and plural names of the module, an icon, and optionally an entity name, description, navigation menu visibility, and status. The response includes details of the created module such as its ID, names, icon, position, navigation path, layout customizations, status, and timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Create a File

ID: post_create_file
Operation: write
Entities: file, contact, deal
Summary: The 'Create a File' API allows users to upload and attach a file to a contact, sales account, deal, or product. The request must include an authorization token and set the Content-Type to multipart/form-data. The body of the request should contain the file to be uploaded, a name for the file, a flag indicating if the file is shared, the ID of the target entity, and the type of the target entity. Upon successful upload, the API returns the ID of the uploaded file, a success message, and the URL of the uploaded file.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Manual Call Log

ID: post_create_manual_call_log
Operation: write
Entities: contact, phone call, note
Summary: This API allows you to create a manual call log for an existing contact, a new contact, or an existing sales account. The endpoint requires a POST request to '/api/phone_calls' with a mandatory 'call_direction' parameter. You can optionally include a 'note' with a mandatory 'description' field if the note is included. The request body must include details about the targetable entity, which can be a contact or a sales account. The response includes details about the created call log, including contact information, notes, user details, and the phone call record.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Record in Custom Module

ID: post_create_record_in_custom_module
Operation: write
Entities: custom module, record, field
Summary: This API allows you to create a record in a custom module, such as 'Loans'. The endpoint requires the entity name as a path parameter. The request must include the 'name' field in the body, which is mandatory, and optionally 'owner_id' and various custom fields. The response returns the details of the created record, including its ID, name, owner, custom fields, timestamps, and links to associated documents and notes.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Sales Activity

ID: post_create_sales_activity
Operation: write
Entities: contact, custom field, sales activity
Summary: This API allows you to create a sales activity in the system. It requires an authorization token and content type in the headers. The request body must include details of the sales activity such as title, notes, targetable ID and type, start and end dates, owner ID, sales activity type ID, and sales activity outcome ID. Optionally, custom fields can be included. The response returns the details of the created sales activity, including its ID, title, start and end dates, type ID, creation and update timestamps, notes, owner ID, outcome ID, and location details.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Task

ID: post_create_task
Operation: write
Entities: contact, user, task
Summary: This API allows you to create a task by sending a POST request to the specified endpoint. The request must include an authorization token in the headers and a JSON body containing the task details such as title, description, due date, owner ID, targetable ID, targetable type, and associated user attributes. The response returns the created task's details including its ID, status, title, description, timestamps, owner ID, due date, and creator ID.
Input Fields: Input Fields
Output Fields: Output Fields

Upsert a Contact

ID: post_upsert_a_contact
Operation: write
Entities: contact, custom field, unique identifier
Summary: The 'Upsert a Contact' API allows users to create or update a contact in the system based on a unique identifier. The API searches for a record with the provided unique identifier and updates it if found, or creates a new record if not. The unique identifier can be an 'id' or a unique field like 'emails'. The request requires an authorization token and a JSON body containing the unique identifier and contact details. The response includes the contact details, with a status code of 200 for updates and 201 for creations. Note that the 'email' attribute is deprecated and should not be used as a unique identifier.
Input Fields: Input Fields
Output Fields: Output Fields

Upsert a Deal

ID: post_upsert_a_deal
Operation: write
Entities: deal, custom field, unique identifier
Summary: The 'Upsert a Deal' API allows you to create or update a deal based on a unique identifier. It checks for an existing record with the provided unique identifier and updates it if found, otherwise, it creates a new record. The API requires an authorization token and content type in the headers. The request body must include a unique identifier object and a deal object with relevant properties. The response includes the details of the deal created or updated, with a response code of 200 for updates and 201 for creations. In case of duplicates, the API will return an error with a list of entity IDs to be merged.
Input Fields: Input Fields
Output Fields: Output Fields

Upsert an Account

ID: post_upsert_an_account
Operation: write
Entities: sales account, unique identifier
Summary: The 'Upsert an Account' API allows users to create or update a sales account based on a unique identifier. If a record with the specified unique identifier exists, it is updated; otherwise, a new record is created. The API requires an authorization token and content type in the headers. The request body must include a unique identifier and sales account data. The response includes details of the sales account, such as ID, name, city, and other attributes. The API returns a 200 status code for updates and a 201 status code for creations. In case of duplicates, an error with a list of entity IDs is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Add Contacts to Marketing List

ID: put_add_contacts_to_marketing_list
Operation: write
Entities: contact, list
Summary: This API allows you to add one or more contacts to a specified marketing list. The request requires a PUT method to the endpoint '/api/lists/[list_id]/add_contacts', where '[list_id]' is the ID of the marketing list. The request headers must include an 'Authorization' token and 'Content-Type' set to 'application/json'. The body of the request should contain an array of contact IDs under the 'ids' key. The response will return a message confirming the number of contacts that were successfully updated.
Input Fields: Input Fields
Output Fields: Output Fields

Add Prices to the Product

ID: put_add_prices_to_product
Operation: write
Entities: product, price detail, currency
Summary: This API allows you to add prices to a product by specifying the pricing type and product pricing details. The request requires an authorization token and content type in the headers. The product ID is specified in the path parameters. The request body includes the pricing type and an array of product pricing objects, each containing currency code, unit price, and optionally setup fee, billing cycle, and billing type. The response returns the updated product details including pricing information.
Input Fields: Input Fields
Output Fields: Output Fields

Add Products to the Deal

ID: put_add_products_to_deal
Operation: write
Entities: product, deal, price
Summary: This API allows you to add products to a specific deal. You can add up to 100 products to a deal using this endpoint. The request requires an authorization token and content type header. The deal ID must be specified in the path parameters, and the 'include' query parameter must be set to 'products'. The request body should contain a 'deal' object with a 'products' array, where each product object includes mandatory 'id' and optional 'quantity', 'discount', 'billing_cycle', 'unit_price', and 'setup_fee' fields. The response returns the updated deal details, including the list of products added to the deal.
Input Fields: Input Fields
Output Fields: Output Fields

Add Products to the Document

ID: put_add_products_to_document
Operation: write
Entities: product, billing cycle, document
Summary: This API allows you to add products to a document. You can add a maximum of 100 products to a document. The request requires an authorization token and content type in the headers. The document ID is specified in the path parameters, and the query parameter 'include' should be set to 'products'. The request body should contain a 'cpq_document' object with a 'products' array, where each product object includes mandatory and optional fields such as 'id', 'quantity', 'discount', 'billing_cycle', 'unit_price', and 'setup_fee'. The response returns the updated document details, including the list of products added.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk-update Documents

ID: put_bulk_update_documents
Operation: write
Entities: cpq_document, document
Summary: The Bulk-update Documents API allows users to update multiple documents at once. The API endpoint is accessed via a PUT request to /api/cpq/cpq_documents/cpq_documents_bulk_update. The request must include an Authorization token and specify the Content-Type as application/json. The request body requires an array of document IDs ('ids') and a 'cpq_document' object containing the fields to update, such as 'owner_id' and 'amount'. Upon successful request submission, the API responds with a message indicating that the update has been queued.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk-update Products

ID: put_bulk_update_products
Operation: write
Entities: product
Summary: The Bulk-update Products API allows users to update multiple products at once by specifying an array of product IDs and the properties to update. The request requires an authorization token and must be in JSON format. The response confirms that the update request has been queued and will notify the user upon success.
Input Fields: Input Fields
Output Fields: Output Fields

Copy Contacts to List

ID: put_copy_contacts_to_list
Operation: write
Entities: contact, list
Summary: The Copy Contacts to List API allows users to copy one or more contacts from one marketing list to another. The API requires a PUT request to the endpoint /api/lists/[list_id]/add_contacts, where [list_id] is the ID of the target marketing list. The request must include an Authorization token and specify the Content-Type as application/json. The body of the request should contain an array of contact IDs under the 'ids' key, which represents the contacts to be copied. Upon successful execution, the API returns a message indicating the number of contacts that were updated.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Prices of the Product

ID: put_delete_prices_of_the_product
Operation: write
Entities: product, product pricing, custom field
Summary: This API allows you to delete the prices of a product by sending a PUT request to the specified endpoint. The request requires an authorization token and content type in the headers. The product ID is specified in the path parameters, and the 'include' query parameter can be used to include related resources. The request body must contain the product pricing details with the '_destroy' flag set to true for the prices you wish to delete. The response returns the updated product details, including its pricing information.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Products of the Deal

ID: put_delete_products_of_the_deal
Operation: write
Entities: product, deal, task
Summary: This API allows you to delete all the products associated with a specific deal by passing an empty array to the 'products' attribute. The request is made using the PUT method to the endpoint 'https://domain.myfreshworks.com/crm/sales/api/deals/[id]?include=products', where '[id]' is the ID of the deal. The request requires an authorization token and a content type header. The response returns the details of the deal, including its ID, name, amount, expected close date, and other related information, confirming that the products have been deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Products of the Document

ID: put_delete_products_of_the_document
Operation: write
Entities: product, deal, cpq document
Summary: This API allows you to delete all the products associated with a CPQ document by sending a PUT request to the specified endpoint. The request requires an authorization token and a content type header. The document ID must be included in the path parameters, and the 'include' query parameter can be used to specify related entities. The request body should contain an empty array for the 'products' attribute to delete all products. The response returns the updated CPQ document details, including its ID, associated deal and contact IDs, document type, stage, validity, addresses, owner, amount, currency, custom fields, timestamps, and other metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Edit Prices of the Product

ID: put_edit_prices_of_the_product
Operation: write
Entities: product, product pricing, custom field
Summary: This API allows you to edit the prices of a product by updating the product_pricing details. The request requires an Authorization token and Content-Type header. The product ID is specified in the path parameters, and the product_pricings array in the request body contains the pricing details to be updated, including id, currency_code, unit_price, setup_fee, billing_cycle, and billing_type. The response returns the updated product details, including product ID, name, category, custom fields, product code, SKU number, and an array of updated product pricing details.
Input Fields: Input Fields
Output Fields: Output Fields

Edit Products of the Deal

ID: put_edit_products_of_the_deal
Operation: write
Entities: product, deal, user
Summary: This API allows you to edit the products of a deal. By passing a product to this API, it will remove other existing products attached to the deal and add or update only the product passed. The request requires an authorization token and content type in the headers. The deal ID is specified in the path parameters. The request body includes the deal object with a list of products, each having properties like id, quantity, discount, billing cycle, unit price, and setup fee. The response returns the updated deal details, including the deal ID, name, amount, expected close date, and a list of products with their details.
Input Fields: Input Fields
Output Fields: Output Fields

Edit Products of the Document

ID: put_edit_products_of_the_document
Operation: write
Entities: product, cpq document
Summary: This API allows you to edit the products of a document. By passing a list of products, it updates the document to include only those products, removing any others that were previously attached. The request requires an authorization token and a JSON body specifying the products to be included. The response returns the updated document details, including product information, document metadata, and associated IDs.
Input Fields: Input Fields
Output Fields: Output Fields

Mark Task as Done

ID: put_mark_task_as_done
Operation: write
Entities: user, task
Summary: The 'Mark Task as Done' API allows users to update the status of a specific task to 'done' by sending a PUT request to the endpoint '/api/tasks/[:task_id]'. The request requires an authorization token and a content type header. The task ID is specified in the path parameters, and the request body must include the task status set to 1. The response includes details of the users associated with the task and the updated task information, such as its ID, status, title, description, timestamps, owner, due date, creator, and associated user IDs.
Input Fields: Input Fields
Output Fields: Output Fields

Move Contacts from List

ID: put_move_contacts_from_list
Operation: write
Entities: contact, marketing list
Summary: This API allows you to move one or more contacts from one marketing list to another. The endpoint requires a PUT request to '/api/lists/[list_id]/move_contacts' with the 'list_id' as a path parameter. The request must include an authorization token in the headers. The body of the request can include an array of contact IDs ('ids') to specify which contacts to move, and the 'from_list_id' to specify the source list. If 'ids' is not provided, all contacts from the 'from_list_id' will be moved to the specified 'list_id'. The response returns a message indicating the update process.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Contacts From List

ID: put_remove_contacts_from_list
Operation: write
Entities: contact, list
Summary: The 'Remove Contacts From List' API allows users to remove one or more contacts from a specified marketing list. The API endpoint is accessed via a PUT request to '/api/lists/[list_id]/remove_contacts'. The request requires an authorization token and a content type header. The 'list_id' path parameter specifies the marketing list. The request body can include an 'ids' array to specify which contacts to remove, or an 'all' boolean to remove all contacts. The response returns a message confirming the number of contacts updated.
Input Fields: Input Fields
Output Fields: Output Fields

Restore a Document

ID: put_restore_document
Operation: write
Entities: contact, deal, document
Summary: This API allows you to restore a document in the system. It requires a PUT request to the endpoint with the document ID specified in the path. The request must include an Authorization token and specify the Content-Type as application/json. The response returns the details of the restored document, including its ID, associated deal and contact IDs, document type, stage, validity, addresses, owner, amount, currency, and other metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Restore a Product

ID: put_restore_product
Operation: write
Entities: product
Summary: This API allows you to restore a product by sending a PUT request to the specified endpoint. The request requires an authorization token and the content type to be specified in the headers. The product ID is included in the path parameters. The response returns the details of the restored product, including its ID, name, category, custom fields, product code, SKU number, parent product ID, validity date, active status, owner ID, deletion status, creation and update timestamps, pricing type, base currency amount, creator and updater IDs, and description.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Contact

ID: put_update_a_contact
Operation: write
Entities: contact, custom field, link
Summary: This API allows you to update the information of a contact using the PUT method. The endpoint requires the contact ID as a path parameter. The request must include headers for authorization and content type. The body of the request can include fields such as first_name, last_name, mobile_number, email, job_title, owner_id, address, city, state, zipcode, country, sales_accounts, and custom_field to update the contact's information. The response returns the updated contact details, including fields like id, first_name, last_name, display_name, mobile_number, and custom_field, along with links to conversations and activities.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Deal

ID: put_update_a_deal
Operation: write
Entities: contact, deal, user
Summary: The 'Update a Deal' API allows you to update the information of a specific deal identified by its ID. The request is made using the PUT method to the endpoint '/api/deals/[id]'. The request headers must include an 'Authorization' token and 'Content-Type' set to 'application/json'. The request body can include fields such as 'name', 'owner_id', 'amount', 'sales_account_id', 'deal_stage_id', 'deal_pipeline_id', and 'custom_field' to update the deal's details. The response includes details of the updated deal and the user who performed the update.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Document

ID: put_update_a_document
Operation: write
Entities: deal, custom field, document
Summary: This API allows you to update the details of a document in the system. It requires the document ID as a path parameter and an authorization token in the headers. The request body should contain the updated details of the document, such as the stage and custom fields. The response returns the updated document details, including information like the document type, stage, addresses, amounts, and custom fields.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Marketing List

ID: put_update_a_marketing_list
Operation: write
Entities: list, marketing list
Summary: This API allows you to update a marketing list by sending a PUT request to the specified endpoint. The request requires an authorization token and the content type to be specified in the headers. The path parameter 'id' is required to identify the marketing list to be updated. The request body must include the new name for the marketing list. The response will indicate whether the update was successful and provide details of the updated list.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Note

ID: put_update_a_note
Operation: write
Entities: contact, account, note
Summary: This API allows you to update a note associated with a contact or an account. The request requires an authorization token and the content type to be specified in the headers. The note ID is specified in the path parameters. The request body must include the note's description, the targetable type (such as 'Contact' or 'SalesAccount'), and the targetable ID. The response returns the updated note details, including its ID, description, creation timestamp, and last update timestamp.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Product

ID: put_update_a_product
Operation: write
Entities: product, custom field, category
Summary: This API allows you to update the details of a product. It requires the product ID as a path parameter and an authorization token in the headers. The request body can include optional fields such as category, is_active status, and custom fields like cf_rating. The response returns the updated product details including its ID, name, category, custom fields, product code, SKU number, and other metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Task

ID: put_update_a_task
Operation: write
Entities: contact, user, task
Summary: This API allows you to update a task by sending a PUT request to the specified endpoint with the task ID. The request requires an authorization token and content type in the headers. The body of the request should contain the task details such as title, description, due date, owner ID, targetable ID and type, and associated user IDs. The response includes the updated task details and associated users.
Input Fields: Input Fields
Output Fields: Output Fields

Update an Account

ID: put_update_an_account
Operation: write
Entities: deal, account, custom field
Summary: This API allows you to update the information of a sales account. It requires the account ID as a path parameter and an authorization token in the headers. The request body can include various fields such as name, owner ID, address, city, state, country, zipcode, number of employees, phone, website, and custom fields. The response returns the updated sales account details, including the ID, name, custom fields, and other account information.
Input Fields: Input Fields
Output Fields: Output Fields

Update an Appointment

ID: put_update_an_appointment
Operation: write
Entities: contact, appointment, user
Summary: This API allows you to update an existing appointment by providing the appointment ID in the path parameters. The request requires an authorization token and content type in the headers. The body of the request should include the appointment details such as title, description, start and end dates, time zone, location, targetable ID and type, and a list of attendees with their types and IDs. The response includes the updated appointment details, a list of attendees, users, and contacts associated with the appointment.
Input Fields: Input Fields
Output Fields: Output Fields

Update Custom Module

ID: put_update_custom_module
Operation: write
Entities: custom module, module customization, layout customization
Summary: The Update Custom Module API allows you to update the details of a custom module, such as its name, icon, and description. The API requires an authorization token and the content type to be specified in the headers. The module ID is specified in the path parameters. The request body includes the module customization details like singular name, plural name, description, icon, show_in_navigation_menu, and status. The response returns the updated module customization details, including the module ID, names, entity name, description, icon, position, navigation menu visibility, custom status, resource path, layout customizations, status, creation and update timestamps, and configuration settings.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Custom Module Record

ID: put_update_custom_module_record
Operation: write
Entities: custom module, property, loan
Summary: This API allows you to update the details of a record in a custom module, such as 'Loans'. The endpoint requires the entity name and the ID of the record to be updated. The request must include an authorization token and the content type in the headers. The body of the request should contain the updated details of the record, including the name, owner ID, and any custom fields. The response returns the updated record details, including timestamps and links to related resources.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Sales Activity

ID: put_update_sales_activity
Operation: write
Entities: contact, custom field, sales activity
Summary: This API allows you to update a sales activity by sending a PUT request to the specified endpoint with the sales activity ID. The request must include an authorization token and a JSON body containing the sales activity details such as title, notes, targetable ID and type, owner ID, sales activity type ID, and sales activity outcome ID. The response returns the updated sales activity details including its ID, title, start and end dates, type ID, creation and update timestamps, notes, owner ID, outcome ID, and additional location and custom field information.
Input Fields: Input Fields
Output Fields: Output Fields