Guides
Signup For Free

Salesflare API Integration

Suggest Edits

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

Delete a Contact

  • ID: delete_a_contact
  • Operation: write
  • Entities: contact
  • Summary: This API endpoint allows you to delete a contact from the Salesflare system. The request requires a DELETE method and the contact_id as a path parameter, which is a required number representing the unique identifier of the contact to be deleted. Upon successful deletion, the API returns a successful response with no specific response body or headers.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Meeting

  • ID: delete_a_meeting
  • Operation: write
  • Entities: meeting
  • Summary: The 'Delete a Meeting' API allows users to delete a specific meeting by providing the meeting's unique identifier as a path parameter. The request method is DELETE, and the endpoint is 'https://api.salesflare.com/meetings/{meeting_id}'. The 'meeting_id' is a required path parameter of type number. Upon successful deletion, the API returns a successful response with no content.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Tag

  • ID: delete_a_tag
  • Operation: write
  • Entities: tag
  • Summary: This API deletes a tag identified by the 'tag_id' path parameter. The 'tag_id' is a required number that specifies the tag to be deleted. Upon successful deletion, the API returns a response with a body containing a 'success' field with the value 'true'.
  • 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 identified by its unique ID. The request is made using the DELETE method to the endpoint 'https://api.salesflare.com/tasks/{id}', where '{id}' is the path parameter representing the task's unique identifier. The response returns a boolean 'success' field indicating whether the task was successfully deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an Account

  • ID: delete_an_account
  • Operation: write
  • Entities: account
  • Summary: This API endpoint allows you to delete an account from the Salesflare system. The request requires the account_id as a path parameter, which is a number representing the unique identifier of the account to be deleted. The DELETE method is used for this operation. Upon successful deletion, the response will be empty, indicating that the account has been successfully removed.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an Opportunity

  • ID: delete_an_opportunity
  • Operation: write
  • Entities: opportunity
  • Summary: This API deletes an opportunity identified by its unique ID from the Salesflare system. The request requires a path parameter 'id', which is a number representing the unique identifier of the opportunity to be deleted. The API uses the DELETE method and does not require any request headers, query parameters, or request body. Upon successful deletion, the API returns a successful response with no specific response body or headers.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Custom Field

  • ID: delete_custom_field
  • Operation: write
  • Entities: custom field, contact, account
  • Summary: This API endpoint allows the user to delete a custom field from a specified item class in Salesflare. The request requires two path parameters: 'itemClass', which specifies the class of the item (such as 'accounts', 'contacts', or 'opportunities'), and 'id', which is the unique identifier of the custom field to be deleted. The API uses the DELETE method and does not require any request body or query parameters. Upon successful deletion, the API returns a successful response with no specific response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an Internal Note

  • ID: delete_internal_note
  • Operation: write
  • Entities: note, message
  • Summary: This API endpoint is used to delete an internal note identified by the message_id. The request method is DELETE and the URL endpoint is https://api.salesflare.com/messages/{message_id}. The only required path parameter is message_id, which is a number representing the ID of the message to be deleted. Upon successful deletion, the API returns a successful response with no specific response body or headers.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a group

  • ID: get_a_group
  • Operation: read
  • Entities: group
  • Summary: This API endpoint retrieves the details of a specific group identified by its unique ID. The request is made using the GET method to the URL https://api.salesflare.com/groups/{id}, where {id} is the path parameter representing the group's unique identifier. The response includes the group's ID, name, and a list of its members, each with their own ID and name.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Account Details

  • ID: get_account_details
  • Operation: read
  • Entities: account
  • Summary: The 'Get Account Details' API retrieves the details of a specific account using the account ID provided in the path parameters. The request is made using the GET method to the endpoint 'https://api.salesflare.com/accounts/{account_id}'. The only required parameter is 'account_id', which is a number representing the ID of the account. The response returns the account details in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Contact Details

  • ID: get_contact_details
  • Operation: read
  • Entities: contact
  • Summary: This API retrieves the details of a contact from Salesflare using the contact's unique identifier. The request requires a path parameter 'contact_id' which is a number representing the contact's ID. The response returns the contact details in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Current User's Details

  • ID: get_current_user_details
  • Operation: read
  • Entities: plan, user, team
  • Summary: This API endpoint retrieves the current user's details from the Salesflare platform. It uses the GET method and does not require any input parameters. The response includes a comprehensive set of user details such as user ID, team information, subscription status, payment type, discount codes, plan details, currency, billing information, creation and modification dates, time zone, email tracking settings, domain, social profiles, phone numbers, positions, addresses, tags, intercom hash, data sources, plan flags, role permissions, and more. The response is structured as a JSON object with nested objects and arrays to represent complex data structures.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Custom Field Details

  • ID: get_custom_field_details
  • Operation: read
  • Entities: custom field, contact, account
  • Summary: This API endpoint retrieves the details of a custom field for a specified item class and ID. The request requires two path parameters: 'itemClass', which specifies the class of the item (either 'accounts', 'contacts', or 'opportunities'), and 'id', which is the unique identifier of the item. The response returns the details of the custom field associated with the specified item.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List a Custom Field's Options

  • ID: get_list_a_custom_fields_options
  • Operation: read
  • Entities: custom field, item class, option
  • Summary: This API endpoint retrieves the list of options for a specified custom field in Salesflare. The request requires two path parameters: 'itemClass', which specifies the class of the item (such as 'accounts', 'contacts', or 'opportunities'), and 'customFieldApiField', which specifies the API field of the custom field. An optional query parameter 'searchString' can be used to filter the options by a search term. The response returns an array of objects, each representing a custom field option with its 'id' and 'name'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Accounts

  • ID: get_list_accounts
  • Operation: read
  • Entities: address, tag, account
  • Summary: The List Accounts API allows users to retrieve a list of accounts from the Salesflare platform. Users can filter the accounts using various query parameters such as account ID, name, creation date, size, domain, tags, address, hotness level, and more. The API returns detailed information about each account, including the owner, domain, size, website, description, interaction dates, social profiles, addresses, email addresses, phone numbers, tags, and parent account details. The response is a JSON array of account objects, each containing comprehensive details about the account.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List an Account's Messages

  • ID: get_list_an_account_messages
  • Operation: read
  • Entities: message, account
  • Summary: This API endpoint retrieves a list of messages for a specific account identified by the account_id path parameter. It supports optional query parameters to filter messages before or after a specific date-time and to limit the number of messages returned. The response includes an array of message objects, each containing a message_id, content, and timestamp.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Contacts

  • ID: get_list_contacts
  • Operation: read
  • Entities: contact, position, account
  • Summary: The List Contacts API allows users to retrieve a list of contacts from the Salesflare platform. Users can filter contacts using various query parameters such as name, email, phone number, domain, modification dates, creation dates, account IDs, tags, roles, addresses, and more. The API supports pagination with 'limit' and 'offset' parameters and allows sorting using the 'order_by' parameter. The response includes detailed information about each contact, including account details, contact information, tags, addresses, phone numbers, positions, social profiles, and custom fields.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Current User's Contacts

  • ID: get_list_current_users_contacts
  • Operation: read
  • Entities: contact, position, account
  • Summary: This API endpoint retrieves a list of contacts for the current user from Salesflare. It supports various query parameters to filter the contacts, such as 'id', 'name', 'email', 'phone_number', 'domain', and date filters like 'modification_after' and 'creation_before'. The response includes detailed information about each contact, including their account details, personal information, tags, addresses, phone numbers, positions, social profiles, and custom fields. The API supports pagination through 'limit' and 'offset' parameters and allows sorting using the 'order_by' parameter.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Custom Field Types

  • ID: get_list_custom_field_types
  • Operation: read
  • Entities: custom field, type
  • Summary: The 'List Custom Field Types' API endpoint retrieves a list of custom field types available in the Salesflare system. This API uses the GET method and does not require any input parameters. The response includes an array of custom field types, each with a unique identifier and a name. The response headers include the content type, which is typically 'application/json'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Custom Fields of a Type

  • ID: get_list_custom_fields_of_a_type
  • Operation: read
  • Entities: custom field, item class
  • Summary: This API endpoint retrieves a list of custom fields for a specified item class, such as accounts, contacts, or opportunities. The request requires the 'itemClass' path parameter to specify the type of item. Optional query parameters include 'includeDisabled' to include disabled fields, 'pipeline' to filter by pipeline number, and 'name' to filter by custom field name. The response returns an array of custom fields, each with an ID, name, type, and enabled status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Email Data Sources

  • ID: get_list_email_data_sources
  • Operation: read
  • Entities: email, data source, team
  • Summary: The List Email Data Sources API retrieves a list of email data sources associated with the user. It includes both personal and team data sources if the session user is an admin and the 'includeTeamDataSources' query parameter is set to true. The response includes detailed information about each data source, such as email addresses, display names, type, status, and synchronization status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Filter Fields for an Entity

  • ID: get_list_filter_fields_for_entity
  • Operation: read
  • Entities: entity, filter field, pipeline
  • Summary: This API endpoint retrieves a list of filter fields for a specified entity in Salesflare. The request requires a path parameter 'entity' to specify the entity type, such as 'account', 'person', or 'opportunity'. Optional query parameters include 'pipeline' to filter by pipeline number and 'includePipelineSpecificPredefinedFilterFields' to include pipeline-specific predefined filter fields. The response includes details about each filter field, such as 'id', 'customfield_id', 'label', 'type', and available 'operators'. The response also provides information about the group, entity, display entity, search entity, and options for each filter field.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Groups

  • ID: get_list_groups
  • Operation: read
  • Entities: group
  • Summary: The 'List Groups' API is used to retrieve a list of groups from the Salesflare platform. This API uses the GET method and does not require any specific headers, path parameters, query parameters, or request body. Upon a successful request, it returns a response containing the list of groups. The response schema is not specified in detail, but it is expected to return a successful response with the list of groups.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Opportunities

  • ID: get_list_opportunities
  • Operation: read
  • Entities: opportunity, contact, account
  • Summary: The List Opportunities API allows users to retrieve a list of sales opportunities from the Salesflare platform. Users can filter opportunities using various query parameters such as search term, opportunity ID, name, stage, owner, account, value range, close date range, creation date range, and more. The API returns detailed information about each opportunity, including its ID, owner, account, stage, assignee, value, currency, close date, status, creator, modification details, pipeline, last interaction, tags, probability, lost reason, files, lead source, start date, main contact, and custom fields. The response is a list of opportunity objects, each containing comprehensive details about the opportunity.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Persons

  • ID: get_list_persons
  • Operation: read
  • Entities: person
  • Summary: The List Persons API retrieves a list of persons from the Salesflare database. It supports filtering by person ID, name, email, and a general search term. The API uses the GET method and requires query parameters to filter the results. The response contains the list of persons matching the criteria.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Pipelines

  • ID: get_list_pipelines
  • Operation: read
  • Entities: stage, group, pipeline
  • Summary: The List Pipelines API allows users to retrieve a list of pipelines from the Salesflare platform. Users can filter the pipelines using query parameters such as 'search', 'order_by', and 'q'. The response includes detailed information about each pipeline, including its ID, team, name, currency details, stages, groups, and pricing information. The API returns a comprehensive list of pipelines with their respective attributes, such as creation and modification dates, order, and whether they are archived or default pipelines.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Stages

  • ID: get_list_stages
  • Operation: read
  • Entities: stage, pipeline
  • Summary: The List Stages API retrieves a list of stages from the Salesflare platform. It supports filtering by stage ID, stage name, pipeline ID, and pipeline name, as well as sorting the results using the 'order_by' query parameter. The response includes an array of stages, each with an ID, name, and associated pipeline details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Supported Currencies

  • ID: get_list_supported_currencies
  • Operation: read
  • Entities: currency
  • Summary: This API endpoint retrieves a list of supported currencies from the Salesflare platform. It uses the GET method and does not require any input parameters. The response is an array of currency objects, each containing an 'id' (number), 'iso' (string) representing the ISO code of the currency, and 'html' (string) representing the HTML symbol of the currency.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Tags

  • ID: get_list_tags
  • Operation: read
  • Entities: tag
  • Summary: The List Tags API endpoint allows users to retrieve a list of tags from the Salesflare system. Users can filter the results using various query parameters such as 'id', 'name', 'limit', 'offset', 'order_by', and 'q'. The 'name' parameter is deprecated and should be replaced with 'q.search'. The response includes details about each tag, such as its ID, team, name, modification and creation dates, counts of associated accounts, persons, and opportunities, total count, and whether the tag is automated.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Tasks

  • ID: get_list_tasks
  • Operation: read
  • Entities: task, meeting, account
  • Summary: The List Tasks API allows users to retrieve a list of tasks from the Salesflare platform. Users can filter tasks using various query parameters such as task IDs, search terms, assignee IDs, task types, account IDs, and more. The API supports ordering and pagination through 'order_by', 'limit', and 'offset' parameters. The response includes detailed information about each task, including its type, associated account, creator, description, reminder date, meeting details, email details, completion status, archive status, modification details, and assignees.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Users

  • ID: get_list_users
  • Operation: read
  • Entities: user
  • Summary: The List Users API endpoint retrieves a list of users from the Salesflare platform. It supports various query parameters to filter the users, such as 'id', 'name', 'email', 'search', 'limit', 'offset', 'order_by', and 'onlyEnabled'. The response includes an array of user objects, each containing 'id', 'name', 'email', and 'enabled' status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Workflows

  • ID: get_list_workflows
  • Operation: read
  • Entities: workflow record, workflow, workflow step record
  • Summary: The List Workflows API allows users to retrieve a list of workflows from the Salesflare platform. Users can specify query parameters such as 'limit', 'offset', 'order_by', 'search', and 'q' to filter and sort the workflows. The response includes details about each workflow, such as its 'id', 'name', 'filter', 'ids', 'condition', 'rules', 'pipeline', 'enabled', 'internal', 'archived', 'options', 'group', 'raw_value', 'search_entity', 'order_by', 'not', 'valid', and 'search'. This API is useful for managing and organizing workflows within the Salesflare system.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Meeting Details

  • ID: get_meeting_details
  • Operation: read
  • Entities: meeting
  • Summary: The 'Get Meeting Details' API retrieves the details of a specific meeting using its unique identifier. The request requires a path parameter 'meeting_id', which is a number representing the meeting's ID. The response returns the details of the meeting in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Meeting Details by Conference ID

  • ID: get_meeting_details_by_conference_id
  • Operation: read
  • Entities: meeting, detail, conference
  • Summary: This API retrieves the details of a meeting by its conference ID. The request requires a path parameter 'conference_id' which is a string representing the unique identifier of the conference. The response returns the details of the conference meeting in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Opportunity Details

  • ID: get_opportunity_details
  • Operation: read
  • Entities: opportunity, contact, account
  • Summary: The Get Opportunity Details API retrieves detailed information about a specific opportunity identified by its unique ID. The request requires a path parameter 'id' which is the unique identifier of the opportunity. The response includes comprehensive details about the opportunity such as owner, account, stage, assignee, value, currency, close date, and more. It also provides information about the last interaction, stage updates, tags, probability, lost reason, lead source, and main contact associated with the opportunity.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Stage Details

  • ID: get_stage_details
  • Operation: read
  • Entities: stage
  • Summary: This API retrieves the details of a specific stage from Salesflare. The request requires a path parameter 'stage_id', which is a number representing the ID of the stage. The response returns the details of the stage in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Tag Details

  • ID: get_tag_details
  • Operation: read
  • Entities: tag
  • Summary: The 'Get Tag Details' API retrieves the details of a specific tag identified by the 'tag_id' path parameter. The request is made using the GET method to the endpoint 'https://api.salesflare.com/tags/{tag_id}'. The 'tag_id' is a required path parameter of type number. The response returns the details of the tag in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Tag Details on Usage in Workflows, Saved Filters & Reports

  • ID: get_tag_details_on_usage
  • Operation: read
  • Entities: workflow, filter, tag
  • Summary: This API endpoint retrieves details on the usage of a specific tag in workflows, saved filters, and reports. The request requires a path parameter 'tag_id', which is a number representing the ID of the tag. The response provides information on where and how the tag is used, although the specific response schema is not detailed in the documentation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get User Details

  • ID: get_user_details
  • Operation: read
  • Entities: user
  • Summary: This API retrieves the details of a user from Salesflare using their unique identifier. The request requires a path parameter 'id' which is a number representing the user's unique ID. The response will contain the user's details in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Workflow Details

  • ID: get_workflow_details
  • Operation: read
  • Entities: workflow, workflow step, workflow step record
  • Summary: The Get Workflow Details API retrieves detailed information about a specific workflow identified by its ID. The request requires a path parameter 'id' which is the unique identifier of the workflow. The response includes various details about the workflow such as its name, filter, associated IDs, pipeline, status, and analytics data. It also provides information on whether the workflow is enabled, internal, or archived, along with scheduling details and steps involved in the workflow.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a workflow's merge fields

  • ID: get_workflow_merge_fields
  • Operation: read
  • Entities: merge field, workflow, campaign
  • Summary: This API endpoint retrieves the merge fields for a workflow. It is currently located under the /campaigns route but may be moved in the future. The request method is GET and it does not require any input parameters. The response includes details about each merge field such as the entity type (either 'account' or 'contact'), display name, API field name, whether it is a custom field, and the custom type if applicable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Call

  • ID: post_create_a_call
  • Operation: write
  • Entities: note, participant, call
  • Summary: The 'Create a Call' API allows users to log a call by providing details such as the date, end date, subject, description, and participants. The 'date' and 'participants' fields are required. The 'minutes' field is deprecated and should be replaced with 'notes'. The API returns a successful response upon creating the call, but the specific response body is not detailed in the documentation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Meeting

  • ID: post_create_a_meeting
  • Operation: write
  • Entities: meeting
  • Summary: The 'Create a Meeting' API allows users to create a new meeting entry in the Salesflare system. The request body must include the 'date' and 'participants' fields as they are required. Other fields such as 'end_date', 'subject', 'description', 'minutes', 'notes', 'phone_type', 'phone_number_hash', and 'type' are optional. The 'minutes' field is deprecated and should be replaced with 'notes'. The 'type' field defaults to 'meeting-live' but can also be 'meeting-phone'. The response schema is not specified in the documentation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Tag

  • ID: post_create_a_tag
  • Operation: write
  • Entities: tag
  • Summary: This API endpoint allows you to create a new tag in the Salesflare system. The request must be made using the POST method to the URL 'https://api.salesflare.com/tags'. The request body must include a JSON object with a 'name' field, which is a required string representing the name of the tag to be created. Upon successful creation, the API responds with a JSON object containing the 'id' of the newly created tag.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Task

  • ID: post_create_a_task
  • Operation: write
  • Entities: task, assignee, account
  • Summary: This API endpoint allows you to create a new task in the Salesflare system. The request must include a description of the task, which is required. Optionally, you can specify an account number, a reminder date, and an array of assignee IDs. The default reminder date is set to '2024-08-20T03:55:50.417Z' if not provided. Upon successful creation, the API returns the unique identifier of the created task.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create an Account

  • ID: post_create_an_account
  • Operation: write
  • Entities: address, customer, account
  • Summary: This API endpoint allows you to create a new account in the Salesflare system. You can specify various details about the account such as owner, name, domain, picture, size, website, description, address, email, phone number, social profiles, tags, links, customers, parent account, and custom fields. The API also supports updating an existing account if the 'update_if_exists' query parameter is set to true. Some properties are deprecated and will be ignored, such as 'region' and '_dirty'. The response will confirm the successful creation of the account.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create an Internal Note

  • ID: post_create_an_internal_note
  • Operation: write
  • Entities: message, mention, account
  • Summary: The 'Create an Internal Note' API allows users to create a note associated with a specific account in the Salesflare system. The request requires the account ID and the content of the note as mandatory fields. Optionally, users can include mentions, which is an array of user IDs, and a date-time string indicating when the note was created. The API responds with a successful status upon creating the note.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create an Opportunity

  • ID: post_create_an_opportunity
  • Operation: write
  • Entities: opportunity, contact, account
  • Summary: This API endpoint is used to create a new opportunity in the Salesflare system. The request is made using the POST method to the URL 'https://api.salesflare.com/opportunities'. The request body must be in JSON format and include various fields such as 'owner', 'account', 'stage', 'lost_reason', 'files', 'lead_source', 'start_date', 'probability', 'assignee', 'creator', 'status', 'name', 'value', 'currency', 'status_date', 'close_date', 'closed', 'tags', 'recurring_price_per_unit', 'frequency', 'units', 'contract_start_date', 'contract_end_date', 'main_contact', and 'custom'. Note that the 'account' field is required. The response will include the ID of the newly created opportunity.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Contact

  • ID: post_create_contact
  • Operation: write
  • Entities: address, contact, account
  • Summary: The 'Create a Contact' API allows users to create a new contact in the Salesflare system. The API accepts a POST request to the endpoint 'https://api.salesflare.com/contacts'. Users can provide various details about the contact in the request body, such as owner, email, name, address, phone numbers, and more. The 'force' query parameter determines whether a contact should be created if a contact with the same email address previously existed. The response returns the ID of the created contact.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Custom Field

  • ID: post_create_custom_field
  • Operation: write
  • Entities: custom field, pipeline, option
  • Summary: This API endpoint allows the creation of a custom field for a specified item class, such as accounts, contacts, or opportunities. The request requires a path parameter 'itemClass' to specify the class of item. The request body must include details about the custom field, such as its type, name, and whether it is enabled or archived. Additional options and constraints can also be specified. Upon successful creation, the API returns the ID of the newly created custom field.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Workflow

  • ID: post_create_workflow
  • Operation: write
  • Entities: workflow, rule, step
  • Summary: This API endpoint allows you to create a new workflow in Salesflare. You can specify the workflow's name, filters, individual record filters, status, and steps. The request body must include a 'name' and can optionally include filters and steps with detailed configurations. The response returns the ID of the newly created workflow.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update an Account's Contacts

  • ID: post_update_account_contacts
  • Operation: write
  • Entities: contact, account
  • Summary: This API endpoint allows you to update the contacts of a specific account in Salesflare. You need to provide the account ID as a path parameter. The request body should be a JSON array containing objects with the contact's ID, a boolean indicating if the contact is dirty, and a boolean indicating if the contact is deleted. The response will return the updated contact details in the same format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update an Account's Users

  • ID: post_update_account_users
  • Operation: write
  • Entities: user, account
  • Summary: This API endpoint allows you to update the users of a specific account in Salesflare. You need to provide the account ID as a path parameter. The request body should be a JSON array containing objects with user details such as 'id', '_dirty', and '_deleted'. The 'id' is the user's ID, '_dirty' is a boolean indicating if the user data is dirty, and '_deleted' is a boolean indicating if the user is deleted. The response schema is not specified in the documentation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Re-enter or Exit an Entity from a Workflow

  • ID: put_re_enter_or_exit_entity_from_workflow
  • Operation: write
  • Entities: audience, workflow, record
  • Summary: This API allows you to re-enter or exit an entity from a workflow. The entity is identified by the 'record_id' path parameter, which should be the contact ID for email workflows. The 'id' path parameter specifies the workflow ID. The request body requires two boolean fields: 'exited' and 'met_goal'. Setting 'exited' to true will exit the entity from the workflow, while setting it to false will re-enter the entity. Note that setting 'met_goal' to false is currently not possible. A successful operation returns a response with a 'success' boolean indicating the result.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Call

  • ID: put_update_a_call
  • Operation: write
  • Entities: meeting, call
  • Summary: The 'Update a Call' API allows users to update details of a specific call meeting identified by 'meeting_id'. The API requires a PUT request to the endpoint 'https://api.salesflare.com/calls/{meeting_id}'. The request body must include 'calendar_id', 'external_id', and 'notes', with 'notes' being the only modifiable property for calendar meetings. The 'minutes' property is deprecated and should be replaced by 'notes'. Optionally, 'edited_by' can be included to specify the user who edited the meeting. The response schema is not detailed in the documentation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Contact

  • ID: put_update_a_contact
  • Operation: write
  • Entities: address, contact, account
  • Summary: This API endpoint allows updating a contact in the Salesflare system. The contact is identified by the 'contact_id' path parameter. The update can include various fields such as name, email, role, addresses, phone numbers, and more. The 'force' query parameter controls whether the contact's name is updated if it matches the first part of the email address. The request body contains detailed information about the contact, including personal details, addresses, phone numbers, and custom fields. The response indicates a successful update but does not specify a detailed response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Meeting

  • ID: put_update_a_meeting
  • Operation: write
  • Entities: note, meeting
  • Summary: This API endpoint allows you to update a meeting in the Salesflare system. You must provide the meeting ID as a path parameter. The request body must include the calendar ID, external ID, and notes, which is the only property you can modify on calendar meetings. The 'minutes' property is deprecated and should not be used. Optionally, you can include the ID of the user who edited the meeting. The response does not specify a particular schema.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Tag

  • ID: put_update_a_tag
  • Operation: write
  • Entities: tag
  • Summary: The 'Update a Tag' API allows users to update the name of an existing tag identified by its 'tag_id'. The request requires a path parameter 'tag_id' which is a number representing the tag's unique identifier. The request body must include a 'name' field, which is a string representing the new name for the tag. Upon successful execution, the API returns a response with a 'success' boolean indicating whether the update was successful.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Task

  • ID: put_update_a_task
  • Operation: write
  • Entities: task, assignee, account
  • Summary: The 'Update a Task' API allows users to update the details of an existing task in the Salesflare system. The API requires the task ID as a path parameter and accepts a JSON payload in the request body with optional fields such as account number, task description, reminder date, assignees, and completion status. Upon successful update, the API returns a response indicating the success status of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Workflow

  • ID: put_update_a_workflow
  • Operation: write
  • Entities: rule, filter, workflow
  • Summary: The 'Update a Workflow' API allows users to update an existing workflow by specifying its ID in the path parameters. The request body must include the workflow's name and can optionally include filters, individual record filters, status, status message, record type, goal, and scheduling details. The API supports complex filtering rules with conditions and operators. The response indicates whether the update was successful.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update an Account's Contacts

  • ID: put_update_account_contacts
  • Operation: write
  • Entities: contact, account
  • Summary: This API updates the contacts of a specified account in Salesflare. The request requires the account_id as a path parameter. The request body should be an array of contact objects, each containing an 'id', '_dirty', and '_deleted' field. The response schema is not specified in the documentation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update an Account's Users

  • ID: put_update_account_users
  • Operation: write
  • Entities: user, account
  • Summary: This API updates the users of a specified account in Salesflare. The request requires the account ID as a path parameter. The request body should be a JSON array containing user objects with 'id', '_dirty', and '_deleted' fields. The 'id' is a number representing the user ID, '_dirty' is a boolean indicating if the user data is dirty, and '_deleted' is a boolean indicating if the user is deleted. The response schema is not specified in the documentation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update an Account

  • ID: put_update_an_account
  • Operation: write
  • Entities: address, phone number, account
  • Summary: The 'Update an Account' API allows users to update the details of an existing account in the Salesflare system. The API requires the account ID as a path parameter and accepts a JSON body with various fields such as name, domain, picture, size, website, description, address, email, phone numbers, social profiles, tags, links, and custom fields. Some fields are deprecated and should be avoided. The response schema is not specified, but a successful update is implied by the documentation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update an Opportunity

  • ID: put_update_an_opportunity
  • Operation: write
  • Entities: opportunity, contact, account
  • Summary: This API endpoint allows you to update an existing opportunity in the Salesflare system. You must provide the unique identifier of the opportunity in the path parameters. The request body can include various fields such as owner, account, stage, lost reason, files, lead source, start date, probability, assignee, creator, name, value, close date, closed status, done status, tags, recurring price per unit, frequency, units, contract start and end dates, main contact, and custom fields. The response will confirm the successful update of the opportunity.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Custom Field

  • ID: put_update_custom_field
  • Operation: write
  • Entities: custom field, contact, account
  • Summary: This API is used to update a custom field in the Salesflare system. It is a deprecated endpoint that allows updating various attributes of a custom field such as its name, enabled status, archived status, and more. The API requires the 'itemClass' and 'id' as path parameters to identify the custom field to be updated. The request body can include details like the custom field's name, whether it is enabled or archived, its order, and options among others. The response does not specify a schema, indicating a successful update.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update an Email Data Source

  • ID: put_update_email_data_source
  • Operation: write
  • Entities: email signature, email data source, campaign
  • Summary: This API endpoint allows you to update an email data source by specifying the unique identifier of the data source in the path parameters. The request body can include an email signature, flags to add the signature to campaigns and replies, and limits on the number of emails that can be sent per day and per hour. The response does not include any specific headers or body content.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update an Internal Note

  • ID: put_update_internal_note
  • Operation: write
  • Entities: message, mention, account
  • Summary: This API updates an internal note for a specific message identified by the 'message_id' path parameter. The request body must include the 'account' ID and the 'body' of the note. Optionally, it can include 'mentions', an array of user IDs, and 'date', the date and time of the note. The API returns a successful response upon updating the note.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated about 1 month ago