Softone Web CRM (Preview)

Boost sales and strengthen customer relationships with the AI-driven SOFTONE WEB CRM. Work from anywhere with a 100% web and cloud-native platform, automate repetitive tasks, and accelerate processes to save time and effort.

This connector is available in the following products and regions:

Service	Class	Regions
Copilot Studio	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	Automate Your Sales with SOFTONE WEB CRM
URL	https://webcrm.softone.gr
Email	support@shopranos.eu

Connector Metadata
Publisher	Softone Technologies
Website	https://webcrm.softone.gr
Privacy Policy	https://webcrm.softone.gr/privacy-policy
Categories	Sales and CRM

Softone Web CRM Power Automate Connector

Welcome to Softone Web CRM Power Automate Connector! This connector seamlessly integrates your company's ERP system with Sales CRM operations, empowering you to automate critical tasks and streamline workflows.

Publisher: Softone Technologies S.A.

Prerequisites

A Valid Softone Web CRM subscription.

How to get credentials

To access your company's data using the Softone Web CRM connector, follow these steps:

Visit the Softone Web CRM login page at crm.shopranos.eu.
After logging in, navigate to the menu and select "User API Keys."
Generate a new API key from the options provided.
Utilize this newly generated API key within the Softone Web CRM connector to gain access to your company's data.

Get started with your connector

To get started with the Softone Web CRM Power Automate Connector, follow these steps:

Installation: Install the connector in your Power Automate environment.
Configuration: Enter your Api Key in order to connect to Softone Web CRM.
Usage: Start automating tasks and workflows seamlessly.

Common errors and remedies

Error 1: Invalid API Key

Symptom: When configuring the connector, you receive an error indicating that the API key is invalid. Remedy: Double-check that you have generated a valid API key in your Softone Web CRM account. Ensure that there are no leading or trailing spaces in the API key when entering it in the connector configuration.

Error 2: Unable to Connect

Symptom: You are unable to establish a connection with the Softone Web CRM when configuring the connector. Remedy: Ensure that you have correctly configured the connector with the API key. Verify that the Softone Web CRM (crm.shopranos.eu) is accessible and not experiencing downtime. Check your network settings to confirm that there are no restrictions preventing the connector from connecting to external services.

Error 3: Missing Permissions

Symptom: You encounter permission-related errors when attempting to perform certain actions using the connector. Remedy: Verify that the API key you generated has the necessary permissions to access the specific resources or perform the actions you are trying to automate. Review the Softone Web CRM documentation to understand the required permissions for various operations.

Error 4: Connector Installation Issues

Symptom: You face difficulties during the installation of the connector in your Power Automate environment. Remedy: Ensure that you follow the installation instructions provided for the Softone Web CRM connector carefully. Check your Power Automate environment for any restrictions or policies that might be affecting the installation process. If the issue persists, reach out to Power Automate support for assistance.

Error 5: Unexpected Behavior

Symptom: The connector is not behaving as expected, or you are encountering unexplained errors during workflow execution. Remedy: Review your workflow configuration and ensure that the inputs and outputs are correctly mapped. Check for any changes or updates in the Softone Web CRM API or connector documentation that might affect your workflow. If the issue persists, contact Softone Web CRM support by sending email to support@shopranos.eu.

Error 6: Slow Performance

Symptom: The connector or workflows are experiencing slow performance. Remedy: Check your network connection and ensure that your Softone Web CRM account is not experiencing performance issues. Additionally, review your workflow design to optimize it for efficiency. If the issue persists, consider reaching out to Softone Web CRM support for assistance. These common errors and their corresponding remedies should help users troubleshoot and resolve issues when using the Softone Web CRM Power Automate Connector. If you encounter any other specific errors or issues, don't hesitate to reach out to Softone Web CRM support for personalized assistance.

FAQ

How can I get support if I encounter issues or have questions?

A: If you encounter any issues or have questions, please reach out to our support team at support@shopranos.eu. We are here to assist you in making the most of Softone Web CRM to streamline your business processes and enhance efficiency.

What are the key benefits of using Softone Web CRM?

Softone Web CRM offers several key benefits, including:

Effortless Integration: Seamlessly connect your ERP system to Sales CRM, enhancing data flow and operational efficiency. Event-Driven Automation: Respond to critical events, such as task or lead creation. Trigger instant notifications and automate approval processes with ease. Microsoft Power Automate Integration: Leverage the power of Microsoft Power Automate to unlock a wide array of automation possibilities. Send important messages, drive approval workflows, and simplify complex processes.

Deployment Instructions

As Softone Web CRM operates as a Platform as a Service (PaaS), there is no manual deployment process required. The platform handles all aspects of deployment and infrastructure management, allowing users to focus directly on utilizing its services and features for their applications.

Creating a connection

The connector supports the following authentication types:


Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
API Key	securestring	The API Key for this api	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Create a new account	Creates a new account in the specified company. The user making the request must have the relevant `x-permissions` to perform this action, and the account details must be valid.
Create a new call	Use this action to create a new call activity, including subject, participants, scheduled time, and status. The created call can later be retrieved, updated, or deleted.
Create a new contact	Creates a new contact in the specified company. The user making the request must have the relevant `x-permissions` to perform this action.
Create a new event	Use this action to schedule or log a new event. Provide details such as title, description, participants, and scheduled date/time. The created event can later be updated, retrieved, or linked to other activities.
Create a new lead	Use this action to create a new lead, including company details, contact information, and source. The created lead can later be enriched, scored, converted, or updated.
Create a new note	Use this action to add a note to a specific activity or entity. Provide details such as title, content, and related references. The created note can later be retrieved, updated, or deleted.
Create a new opportunity	Use this action to create a new opportunity in the sales pipeline. An opportunity typically represents a potential deal with an account, linked to a lead or created independently.
Create a new task	Use this action to add a new task to your system. Provide details such as subject, description, due date, priority, and assigned user. The created task can later be retrieved, updated, or deleted.
Delete a call by ID	Permanently removes the specified call from the system. Only calls accessible to the current user can be deleted. Ensure the call is not linked to other processes before deletion.
Delete a contact	Deletes the specified contact from the given company. Access is determined by the company context provided in the `x-companyid` header.
Delete a lead by ID	Permanently deletes a lead from the system. Ensure the lead is not needed for further processing or conversion before deletion.
Delete a note by ID	Permanently removes the specified note from the system. Ensure that the note is not linked to other processes before deletion. Only notes accessible to the current user can be deleted.
Delete a task by ID	Permanently removes the specified task from the system. Ensure that the task is not linked to other processes before deletion. Only tasks accessible to the current user can be deleted.
Delete an account	Deletes the specified account for the given company. The request must include valid `x-companyid` and the appropriate permissions to proceed.
Delete an event by ID	Permanently removes the specified event from the system. Ensure that the event is not linked to other processes before deletion. Only events accessible to the current user can be deleted.
Delete an opportunity by ID	Permanently removes an opportunity from the system. Ensure the opportunity is no longer needed before deletion, as the action cannot be undone.
Retrieve a backoffice user by ID	Returns full details of the specified user, including role information within the given company. Access is determined by the company context provided in the request header.
Retrieve a call task by ID	Returns detailed information for the specified call, including subject, participants, scheduled time, and status. Use this action to view or reference a specific call in your automation.
Retrieve a contact by ID	Returns details for the specified contact, providing company-specific data and information. Access is determined by the company context provided in the `x-companyid` request header.
Retrieve a lead by ID	Returns detailed information for the specified lead, including company details, contact info, source, and status. Use this action to view or update a specific lead.
Retrieve a note by ID	Returns detailed information for the specified note, including content, creator, and related entity. Use this action to view or reference a specific note in your automation.
Retrieve a task by ID	Returns detailed information for the specified task, including subject, description, due date, priority, and assigned user. Use this action to view or reference a specific task in your automation.
Retrieve a team by its unique identifier	Returns full details of the specified team.
Retrieve all accounts for a company	Returns a list of all accounts belonging to the specified company. The user making the request must have appropriate permissions, defined in the request headers. Filters can be applied using query string parameters.
Retrieve all calls	Lists all call activities accessible to the current user. You can filter results using search criteria such as assigned user, status, or date range. Useful for reporting, dashboards, or automations that process multiple calls.
Retrieve all contacts for a company	Returns a list of all contacts belonging to the specified company. The user making the request must have appropriate permissions as determined by the headers. Filters can be applied using request parameters.
Retrieve all events accessible to the user	Lists all events accessible to the current user. You can filter results using search criteria such as date range, assigned user, or status. Useful for reporting, dashboards, or automations that process multiple events.
Retrieve all leads with pagination	Lists all leads accessible to the current user. Supports pagination and filtering via query parameters. Useful for dashboards, reports, or integrations that require batch processing of leads.
Retrieve all notes accessible to the user	Lists all notes accessible to the current user. You can filter results using search criteria such as creator, related entity, or date range. Useful for reporting, dashboards, or automations that process multiple notes.
Retrieve all opportunities with pagination	Lists opportunities accessible to the user, based on scope (Me, Team, or All). Supports filtering, searching, and pagination. Useful for dashboards, reports, and integrations that require batch access.
Retrieve all tasks accessible to the user	Lists all tasks accessible to the current user. You can filter results using search criteria such as assigned user, status, or date range. Useful for reporting, dashboards, or automations that process multiple tasks.
Retrieve an account by ID	Returns details for the specified account, including company-specific data. Access is determined by the company context provided in the `x-companyid` request header.
Retrieve an event by ID	Returns detailed information for the specified event, including title, participants, scheduled time, and status. Use this action to view or reference a specific event in your automation.
Retrieve an opportunity by ID	Returns full details of the specified opportunity, including owner and linked account. Access is restricted based on user permissions.
Update a call by ID	Use this action to modify details of an existing call, such as subject, participants, scheduled time, or status. Only calls accessible to the current user can be updated.
Update a lead by ID	Updates details of an existing lead such as company info, contact details, status, or source. Only leads accessible to the user can be updated.
Update an existing account	Updates details for the specified account in the given company. User permissions and company context are validated during this operation. Only authorized users with valid data can perform the update.
Update an existing contact	Updates details for the specified contact in the given company. User permissions and company context are validated during this operation.
Update an existing event by ID	Use this action to modify details of an existing event, such as title, description, participants, or scheduled time. Only events accessible to the current user can be updated.
Update an existing note by ID	Use this action to modify details of an existing note, such as content or related references. Only notes accessible to the current user can be updated.
Update an existing opportunity by ID	Applies changes to fields of the specified opportunity, such as name, stage, amount, or account link. Only accessible if the user has write permissions.
Update an existing task by ID	Use this action to modify details of an existing task, such as subject, description, due date, priority, or assigned user. Only tasks accessible to the current user can be updated.

Create a new account

Operation ID:: Account_Create

Creates a new account in the specified company.
The user making the request must have the relevant x-permissions to perform this action, and the account details must be valid.

Parameters

Name	Key	Required	Type
Id	id		string
CompanyId	companyId		string
Name	name	True	string
Code	code		string
Tin	tin		string
Email	email		string
Phone	phone		string
SourceId	sourceId		string
SourceParentId	sourceParentId		string
SourceOwnerId	sourceOwnerId		string
PrimaryContactIds	primaryContactIds		array of string
ParentAccountId	parentAccountId		string
OwnerId	ownerId		string
Address1	address1		string
Address2	address2		string
City	city		string
State	state		string
Latitude	latitude		string
Longtitude	longtitude		string
Country	country		string
CountryCode	countryCode		string
PostalCode	postalCode		string
FirstName	firstName		string
LastName	lastName		string
PhoneNumber	phoneNumber		string
Email	email		string
UpdateDate	updateDate		date-time
InsertDate	insertDate		date-time
TaxOffice	taxOffice		string
AccountSourceTypeId	accountSourceTypeId		string
IndustryId	industryId		string
TierId	tierId		string
Website	website		string
AccountDescription	accountDescription		string
NoOfEmployees	noOfEmployees		integer
AnnualRevenue	annualRevenue		double
CreatedBy	createdBy		string
LastModifiedBy	lastModifiedBy		string
Fax	fax		string
OwnershipId	ownershipId		string
RatingId	ratingId		string
ClassificationId	classificationId		string
ExtraFields	extraFields		object
AssignedTeams	assignedTeams		array of string
AiScore	aiScore		double
AiScoreReasoning	aiScoreReasoning		string
AiSentiment	aiSentiment		integer
AiGenerationDate	aiGenerationDate		date-time

Returns

Body: Customer.Api.Features.Accounts.AccountDTO

Create a new call

Operation ID:: Call_Create

Use this action to create a new call activity, including subject, participants, scheduled time, and status.
The created call can later be retrieved, updated, or deleted.

Parameters

Name	Key	Type
due Date	dueDate	date-time
subject	subject	string
assigned To Type	assignedToType	string
assigned To Id	assignedToId	string
related To Type	relatedToType	string
related To Id	relatedToId	string
contact Type	contactType	string
contact Ids	contactIds	array of string
status	status	string
call Duration	callDuration	date-span
call Result Id	callResultId	string
comments	comments	string
editor Body	editorBody	string
priority Id	priorityId	string
position	position	integer
parent Id	parentId	string
reminder Set	reminderSet	boolean
sort Date	sortDate	date-time
source Id	sourceId	string
source Assigned To Id	sourceAssignedToId	string
source Related To Id	sourceRelatedToId	string
source Contact Ids	sourceContactIds	array of string
call Direction	callDirection	string

Returns

Body: Task.Api.Features.Calls.CallDTO

Create a new contact

Operation ID:: Contact_Create

Creates a new contact in the specified company.
The user making the request must have the relevant x-permissions to perform this action.

Parameters

Name	Key	Type
Id	id	string
CompanyId	companyId	string
OwnerId	ownerId	string
AccountIds	accountIds	array of string
SourceId	sourceId	string
SourceOwnerId	sourceOwnerId	string
SourceAccountIds	sourceAccountIds	array of string
FirstName	firstName	string
LastName	lastName	string
MiddleName	middleName	string
SalutationId	salutationId	string
Suffix	suffix	string
Email	email	string
Phone	phone	string
MobilePhone	mobilePhone	string
Fax	fax	string
CallOptOut	callOptOut	boolean
EmailOptOut	emailOptOut	boolean
EmailAddress	emailAddress	string
Type	type	string
OptOut	optOut	boolean
PhoneNumber	phoneNumber	string
Type	type	string
OptOut	optOut	boolean
JobTitle	jobTitle	string
GenderId	genderId	string
PronounceId	pronounceId	string
Address1	address1	string
Address2	address2	string
City	city	string
State	state	string
Latitude	latitude	string
Longtitude	longtitude	string
Country	country	string
CountryCode	countryCode	string
PostalCode	postalCode	string
FirstName	firstName	string
LastName	lastName	string
PhoneNumber	phoneNumber	string
Email	email	string
InsertDate	insertDate	date-time
UpdateDate	updateDate	date-time
CreatedBy	createdBy	string
LastModifiedBy	lastModifiedBy	string
Department	department	string
ReportsTo	reportsTo	string
Assistant	assistant	string
AssistantPhone	assistantPhone	string
Birthday	birthday	date-time
Description	description	string
LastStayInTouchReportedDate	lastStayInTouchReportedDate	date-time
LastStayInTouchSaveDate	lastStayInTouchSaveDate	date-time
AccountSourceTypeId	accountSourceTypeId	string
FullName	fullName	string
ExtraFields	extraFields	object
AssignedTeams	assignedTeams	array of string

Returns

Body: Customer.Api.Features.Contacts.ContactDTO

Create a new event

Operation ID:: Event_Create

Use this action to schedule or log a new event.
Provide details such as title, description, participants, and scheduled date/time.
The created event can later be updated, retrieved, or linked to other activities.

Parameters

Name	Key	Type
update Date	updateDate	date-time
subject	subject	string
task Type	taskType	string
assigned To Type	assignedToType	string
assigned To Id	assignedToId	string
related To Type	relatedToType	string
related To Id	relatedToId	string
contact Type	contactType	string
contact Ids	contactIds	array of string
description	description	string
editor Body	editorBody	string
priority Id	priorityId	string
longitude	longitude	string
latitude	latitude	string
start Date	startDate	date-time
end Date	endDate	date-time
reminder Set	reminderSet	boolean
created By	createdBy	string
last Modified By	lastModifiedBy	string
position	position	integer
parent Id	parentId	string
repeat	repeat	string
event Status	eventStatus	string
event Result Id	eventResultId	string
recurrence Interval	recurrenceInterval	string
source Id	sourceId	string
source Assigned To Id	sourceAssignedToId	string
source Related To Id	sourceRelatedToId	string
source Contact Ids	sourceContactIds	array of string
team Members	teamMembers	array of string

Returns

Body: Task.Api.Features.Events.EventDTO

Create a new lead

Operation ID:: Lead_Create

Use this action to create a new lead, including company details, contact information, and source. The created lead can later be enriched, scored, converted, or updated.

Parameters

Name	Key	Required	Type
job Title	jobTitle		string
lead Status Id	leadStatusId		string
first Name	firstName	True	string
last Name	lastName		string
middle Name	middleName		string
salutation Id	salutationId		string
suffix	suffix		string
email	email		string
phone	phone		string
mobile Phone	mobilePhone		string
email Address	emailAddress		string
type	type		string
opt Out	optOut		boolean
phone Number	phoneNumber		string
type	type		string
opt Out	optOut		boolean
call Opt Out	callOptOut		boolean
email Opt Out	emailOptOut		boolean
rating Id	ratingId		string
owner Id	ownerId		string
owner Type	ownerType		string
website	website		string
company	company		string
industry Id	industryId		string
no Of Employees	noOfEmployees		integer
account Source Type Id	accountSourceTypeId		string
address1	address1		string
address2	address2		string
city	city		string
state	state		string
country	country		string
postal Code	postalCode		string
description	description		string
annual Revenue	annualRevenue		double
last Transfer Date	lastTransferDate		date-time
gender Id	genderId		string
pronounce Id	pronounceId		string
status	status		string
extra Fields	extraFields		object

Returns

Body: SalesPipeline.Api.Features.Lead.LeadDto

Create a new note

Operation ID:: Note_Create

Use this action to add a note to a specific activity or entity.
Provide details such as title, content, and related references.
The created note can later be retrieved, updated, or deleted.

Parameters

Name	Key	Required	Type
task Type	taskType		string
related To Type	relatedToType		string
contact Type	contactType		string
related To Id	relatedToId		string
subject	subject	True	string
body	body		string
editor Body	editorBody		string
contact Ids	contactIds		array of string

Returns

Body: Task.Api.Features.Notes.NoteDTO

Create a new opportunity

Operation ID:: Opportunity_Create

Use this action to create a new opportunity in the sales pipeline.
An opportunity typically represents a potential deal with an account, linked to a lead or created independently.

Parameters

Name	Key	Required	Type
type Id	typeId		string
owner Id	ownerId		string
account Id	accountId		string
name	name	True	string
amount	amount		double
forecast Category Id	forecastCategoryId		string
sales Pipeline Id	salesPipelineId		string
close Date	closeDate	True	date-time
probability	probability		integer
score	score		integer
description	description		string
quote Id	quoteId		string
opportunity Status Id	opportunityStatusId		string
status	status		string
account Source Type Id	accountSourceTypeId		string
next Step	nextStep		string
budget Confirmed	budgetConfirmed		boolean
discovery Completed	discoveryCompleted		boolean
expected Revenue	expectedRevenue		double
loss Reason Id	lossReasonId		string
private	private		boolean
extra Fields	extraFields		object

Returns

Body: SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Create a new task

Operation ID:: Task_Create

Use this action to add a new task to your system.
Provide details such as subject, description, due date, priority, and assigned user.
The created task can later be retrieved, updated, or deleted.

Parameters

Name	Key	Type
task Type	taskType	string
subject	subject	string
due Date	dueDate	date-time
status	status	string
priority Id	priorityId	string
assigned To Id	assignedToId	string
assigned To Type	assignedToType	string
contact Ids	contactIds	array of string
contact Type	contactType	string
related To Id	relatedToId	string
related To Type	relatedToType	string
task Sub Type Id	taskSubTypeId	string
comments	comments	string
editor Body	editorBody	string
reminder Set	reminderSet	boolean
position	position	integer
parent Id	parentId	string

Returns

Body: Task.Api.Features.Tasks.TaskDTO

Delete a call by ID

Operation ID:: Call_Delete

Permanently removes the specified call from the system.
Only calls accessible to the current user can be deleted.
Ensure the call is not linked to other processes before deletion.

Parameters

Name	Key	Required	Type	Description
id	id	True	string	The unique identifier of the call to delete.

Delete a contact

Operation ID:: Contact_Delete

Deletes the specified contact from the given company.
Access is determined by the company context provided in the x-companyid header.

Parameters

Name	Key	Required	Type	Description
contact Id	contactId	True	string	The unique identifier of the contact to delete.

Delete a lead by ID

Operation ID:: Lead_Delete

Permanently deletes a lead from the system. Ensure the lead is not needed for further processing or conversion before deletion.

Parameters

Name	Key	Required	Type	Description
id	id	True	string	The unique identifier of the lead to delete.

Delete a note by ID

Operation ID:: Note_Delete

Permanently removes the specified note from the system.
Ensure that the note is not linked to other processes before deletion.
Only notes accessible to the current user can be deleted.

Parameters

Name	Key	Required	Type	Description
id	id	True	string	The unique identifier of the note to delete.

Delete a task by ID

Operation ID:: Task_Delete

Permanently removes the specified task from the system.
Ensure that the task is not linked to other processes before deletion.
Only tasks accessible to the current user can be deleted.

Parameters

Name	Key	Required	Type	Description
id	id	True	string	The unique identifier of the task to delete.

Delete an account

Operation ID:: Account_Delete

Deletes the specified account for the given company.
The request must include valid x-companyid and the appropriate permissions to proceed.

Parameters

Name	Key	Required	Type	Description
account Id	accountId	True	string	The unique identifier of the account to delete.

Delete an event by ID

Operation ID:: Event_Delete

Permanently removes the specified event from the system.
Ensure that the event is not linked to other processes before deletion.
Only events accessible to the current user can be deleted.

Parameters

Name	Key	Required	Type	Description
id	id	True	string	The unique identifier of the event to delete.

Delete an opportunity by ID

Operation ID:: Opportunity_Delete

Permanently removes an opportunity from the system.
Ensure the opportunity is no longer needed before deletion, as the action cannot be undone.

Parameters

Name	Key	Required	Type	Description
id	id	True	string	The unique identifier of the opportunity to delete.

Retrieve a backoffice user by ID

Operation ID:: User_GetById

Returns full details of the specified user, including role information within the given company.
Access is determined by the company context provided in the request header.

Parameters

Name	Key	Required	Type	Description
user Id	userId	True	string	The unique identifier of the backoffice user to retrieve.

Returns

Body: Identity.Api.BackOfficeUsers.GetUser.GetUserResponse

Retrieve a call task by ID

Operation ID:: Call_GetById

Returns detailed information for the specified call, including subject, participants, scheduled time, and status.
Use this action to view or reference a specific call in your automation.

Parameters

Name	Key	Required	Type	Description
id	id	True	string	The unique identifier of the call task.

Returns

Body: Task.Api.Features.Calls.CallDTO

Retrieve a contact by ID

Operation ID:: Contact_GetById

Returns details for the specified contact, providing company-specific data and information.
Access is determined by the company context provided in the x-companyid request header.

Parameters

Name	Key	Required	Type	Description
contact Id	contactId	True	string	The unique identifier of the contact to retrieve.

Returns

Body: Customer.Api.Features.Contacts.Contact

Retrieve a lead by ID

Operation ID:: Lead_GetById

Returns detailed information for the specified lead, including company details, contact info, source, and status. Use this action to view or update a specific lead.

Parameters

Name	Key	Required	Type	Description
id	id	True	string	The unique identifier of the lead.

Returns

Body: SalesPipeline.Api.Features.Lead.LeadDto

Retrieve a note by ID

Operation ID:: Note_GetById

Returns detailed information for the specified note, including content, creator, and related entity.
Use this action to view or reference a specific note in your automation.

Parameters

Name	Key	Required	Type	Description
id	id	True	string	The unique identifier of the note.

Returns

Body: Task.Api.Features.Notes.NoteDTO

Retrieve a task by ID

Operation ID:: Task_GetById

Returns detailed information for the specified task, including subject, description, due date, priority, and assigned user.
Use this action to view or reference a specific task in your automation.

Parameters

Name	Key	Required	Type	Description
id	id	True	string	The unique identifier of the task.

Returns

Body: Task.Api.Features.Tasks.TaskDTO

Retrieve a team by its unique identifier

Operation ID:: Team_GetById

Returns full details of the specified team.

Parameters

Name	Key	Required	Type	Description
id	id	True	string	The unique identifier of the team.

Returns

Body: Identity.Api.Teams.Dtos.GetTeamResponse

Retrieve all accounts for a company

Operation ID:: Account_GetAll

Returns a list of all accounts belonging to the specified company.
The user making the request must have appropriate permissions, defined in the request headers.
Filters can be applied using query string parameters.

Parameters

Name	Key	Type	Description
Parent Account	ParentAccount	string	Sets the ParentAccount associated with the current search.
Phone	Phone	string	Sets the phone number associated with the current search.
Suggestions	Suggestions	string	Sets the Suggestions associated with the current search. This value is used to filter search results based on the specified suggestions.
Owner Id	OwnerId	string	Specifies the OwnerId filter applied to the current account search.
Ownership Id	OwnershipId	string	Sets the OwnershipId used as a filter in the search.
Rating Id	RatingId	string	Sets the RatingId associated with the current search. Used to filter accounts based on their rating identifier.
Classification Id	ClassificationId	string	Sets the ClassificationId used to filter accounts based on their classification.
Industry Id	IndustryId	string	Sets the IndustryId associated with the current search.
Account Source Type Id	AccountSourceTypeId	string	Sets the AccountSourceTypeId associated with the current search.
Primary Contact Id	PrimaryContactId	string	Represents the identifier of the primary contact associated with the account search.
Assigned Teams	AssignedTeams	string	Sets the list of teams assigned to the current search.
Search	Search	string	Sets the search term used to filter the current search results.
Name	Name	string	Gets or sets the Name of the account to be used as a filter in the search criteria.
Id	Id	string	Represents a collection of account identifiers used to filter the search results.
Page	Page	integer	Specifies the current page number for paginated search results.
Page Size	PageSize	integer	Specifies the number of items to be displayed per page in paginated search results.
Sort	Sort	string	Represents the sort parameter for ordering search results. Accepts a comma-separated list of fields prefixed by "+" for ascending order or "-" for descending order. Defaults to "id" if not specified.

Returns

response: array of Customer.Api.Features.Accounts.AccountDTO

Retrieve all calls

Operation ID:: Call_GetAll

Lists all call activities accessible to the current user.
You can filter results using search criteria such as assigned user, status, or date range.
Useful for reporting, dashboards, or automations that process multiple calls.

Parameters

Name	Key	Type	Description
Id	Id	string	Unique identifier used to filter and search specific tasks.
Status	Status	string	Status of the task
Priority Id	PriorityId	string	Represents the identifier for the priority associated with a task, enabling filtering and categorization based on priority levels.
Created By	CreatedBy	string	Identifier representing the user who created the task, utilized for filtering purposes.
Last Modified By	LastModifiedBy	string	Specifies the identifier or name of the last user who modified the task. This property is utilized to filter and search tasks based on the modifying user.
Due Date	DueDate	date-time	Represents the date when the task is due to be completed, or by which action is required. Used as a filter to search or query tasks based on their due date.
Sort Date	SortDate	string	Represents the date or dates that can be used to sort tasks. This property allows filtering of tasks based on specified sort dates.
Assigned To Id	AssignedToId	string	Represents the identifiers of the users or entities to whom the task or call is assigned.
Related To Id	RelatedToId	string	Identifier that links the task to a related entity. Used for filtering or searching tasks associated with other entities.
Call Result Id	CallResultId	string	Represents the identifier for a call result, which can be used to filter tasks based on their associated call result.
Search	Search	string	Represents a search term that can be used to filter data by applying a "StartsWith" operation on relevant fields.
Page	Page	integer	Sets the current page number for paginated results. This value is used to determine the starting point of the dataset for pagination.
Page Size	PageSize	integer	Sets the number of items to be included in a single page of paginated results. This value determines the size of the dataset to be returned per page.
Sort	Sort	string	Represents the sorting criteria for the search results. This property defines the sorting order and fields for the dataset.

Returns

response: array of Task.Api.Features.Calls.CallDTO

Retrieve all contacts for a company

Operation ID:: Contact_GetAll

Returns a list of all contacts belonging to the specified company.
The user making the request must have appropriate permissions as determined by the headers. Filters can be applied using request parameters.

Parameters

Name	Key	Type	Description
Name	Name	string	Sets the Name of the contact to be used as a filter in the search process.
Owner Id	OwnerId	string	Specifies the OwnerId(s) used to filter the search results for contacts.
Suggestions	Suggestions	string	Sets the Suggestions to be used as a filter in the search process.
Account Source Type Id	AccountSourceTypeId	string	Specifies the Account Source Type ID to be used as a filter in the search query.
First Name	FirstName	string	Sets the FirstName of the contact to be used as a filter in the search process.
Last Name	LastName	string	Sets the Last Name of the contact to be used as a filter in the search process.
Phone	Phone	string	Sets the Phone number of the contact to be used as a filter in the search process.
Mobile Phone	MobilePhone	string	Sets the mobile phone number to be used as a filter in the contact search process.
Account Ids	AccountIds	string	Sets the Account IDs to be used as a filter in the search process.
Email	Email	string	Specifies the email address of the contact to be used as a filter during the search process.
Id	Id	string	Specifies the list of Contact IDs to be used as a filter in the search process.
Assigned Teams	AssignedTeams	string	Specifies the list of team identifiers assigned to the contact, used as a filter in the search process.
Search	Search	string	Specifies the term or value to be used as a general search filter when querying contacts.
Page	Page	integer	Specifies the current page number for paginated search results.
Page Size	PageSize	integer	Specifies the number of items to be displayed per page in paginated search results.
Sort	Sort	string	Represents the sort parameter for ordering search results. Accepts a comma-separated list of fields prefixed by "+" for ascending order or "-" for descending order. Defaults to "id" if not specified.

Returns

response: array of Customer.Api.Features.Contacts.ContactDTO

Retrieve all events accessible to the user

Operation ID:: Event_GetAll

Lists all events accessible to the current user.
You can filter results using search criteria such as date range, assigned user, or status.
Useful for reporting, dashboards, or automations that process multiple events.

Parameters

Name	Key	Type	Description
Id	Id	string	Sets the unique identifier associated with the event. Setting this property will automatically add a corresponding filter
event Status	Status	string	Sets the event status associated with the search criteria. Setting this property will automatically add a corresponding filter
event Status	EventStatus	string	Sets the status of the event being queried. Setting this property will automatically add a corresponding filter
Start Date	StartDate	date-time	Sets the start date for the event search criteria. Setting this property will automatically add a corresponding filter
Assigned To Id	AssignedToId	string	Sets the collection of identifiers associated with the assigned users of the event. Setting this property will automatically add a corresponding filter
Related To Id	RelatedToId	string	Sets the identifier of the entity that the event is related to. Setting this property will automatically apply a filter with the
Sort Date	SortDate	string	Sets the sorting criteria based on specific date values related to the event. When setting this property, each value in the collection is automatically added
Parent Id	ParentId	string	Sets the identifier of the parent entity associated with the event. When this property is set, a corresponding filter is automatically added based on the provided value.
Event Result Id	EventResultId	string	Sets the identifier for the event result used for filtering events. Assigning a value to this property automatically applies the corresponding filter.
Priority Id	PriorityId	string	Sets the priority identifier associated with the event. Setting this property will automatically add a corresponding filter based on the priority ID.
Search	Search	string	Sets the search query used to filter events based on a specific keyword or criteria. When this property is set, a corresponding filter of type Task.Api.Models.Enums.TaskFilterType.Search is automatically added.
Last Modified By	LastModifiedBy	string	Sets the identifier of the user who last modified the event. Setting this property will add a filter based on the last modified user's identifier.
Created By	CreatedBy	string	Sets the user identifier of the entity that created the event. Setting this property will automatically add a corresponding filter for events created by the specified user.
Page	Page	integer	Sets the current page number for paginated results. This value is used to determine the starting point of the dataset for pagination.
Page Size	PageSize	integer	Sets the number of items to be included in a single page of paginated results. This value determines the size of the dataset to be returned per page.
Sort	Sort	string	Represents the sorting criteria for the search results. This property defines the sorting order and fields for the dataset.

Returns

response: array of Task.Api.Features.Events.EventDTO

Retrieve all leads with pagination

Operation ID:: Lead_GetAll

Lists all leads accessible to the current user. Supports pagination and filtering via query parameters.
Useful for dashboards, reports, or integrations that require batch processing of leads.

Parameters

Name	Key	Type	Description
Id	Id	string	Sets the list of Lead IDs used as a filter criterion in the search query.
Name	Name	string	Sets the name of the lead, which serves as a filter criterion in the search query.
First Name	FirstName	string	Sets the first name of the lead, used as a filter criterion in search queries.
Last Name	LastName	string	Sets the last name of the lead, used as a filter criterion in the search query.
Insert Date	InsertDate	string	Sets the list of Insert Dates used as a filter criterion in the search query.
Phone	Phone	string	Sets the phone number associated with the lead. This property is used as a filter criterion in the search query.
Mobile Phone	MobilePhone	string	Sets the mobile phone number of a lead, used as a filter criterion in search queries.
Email	Email	string	Sets the email address of the lead used as a filter criterion in the search query.
Owner Id	OwnerId	string	Represents the list of owner IDs used as a filter criterion in the search query.
owner Type	OwnerType	string	Specifies the type of owner for the lead, such as an individual or a queue. This property is used as a filtering criterion in the search query.
Account Source Type Id	AccountSourceTypeId	string	Specifies the type of the account source used as a filter criterion in the search query.
Lead Status Id	LeadStatusId	string	Filters leads based on their associated lead status ID.
Industry Id	IndustryId	string	Sets the Industry ID used as a filter criterion in the search query.
Status	Status	string	Represents the status filter used in lead search queries. This filter allows for specifying the status of leads, such as "Default," "Qualified," or "Unqualified."
Search	Search	string	Sets the search keyword that is used as a filter criterion in the search query.
Page	Page	integer	Sets the page number for paginated results. Defaults to 1.
Page Size	PageSize	integer	Sets the number of items per page for paginated results. Defaults to 25.
Sort	Sort	string	Specifies the sort criteria as a string. The sort string determines the property and the direction (ascending or descending) for sorting results. Multiple criteria can be combined using a comma separator.

Returns

response: array of SalesPipeline.Api.Features.Lead.LeadDto

Retrieve all notes accessible to the user

Operation ID:: Note_GetAll

Lists all notes accessible to the current user.
You can filter results using search criteria such as creator, related entity, or date range.
Useful for reporting, dashboards, or automations that process multiple notes.

Parameters

Name	Key	Type	Description
Id	Id	string	Gets or sets the list of identifiers used to filter notes.
Search	Search	string	Gets or sets the text used to perform a search across notes.
Related To Id	RelatedToId	string	Gets or sets the identifier related to a specific entity for filtering notes.
related To Type	RelatedToType	string	Gets or sets the type of entity related to the note.
Created By	CreatedBy	string	Gets or sets the identifier for the user who created the note.
Last Modified By	LastModifiedBy	string	Gets or sets the identifier of the user who last modified the note.
Page	Page	integer	Sets the current page number for paginated results. This value is used to determine the starting point of the dataset for pagination.
Page Size	PageSize	integer	Sets the number of items to be included in a single page of paginated results. This value determines the size of the dataset to be returned per page.
Sort	Sort	string	Represents the sorting criteria for the search results. This property defines the sorting order and fields for the dataset.

Returns

response: array of Task.Api.Features.Notes.NoteDTO

Retrieve all opportunities with pagination

Operation ID:: Opportunity_GetAll

Lists opportunities accessible to the user, based on scope (Me, Team, or All).
Supports filtering, searching, and pagination.
Useful for dashboards, reports, and integrations that require batch access.

Parameters

Name	Key	Type	Description
Id	Id	string	Sets the identifiers for the opportunity search filter.
Owner Id	OwnerId	string	Sets the identifiers of the owners associated with the opportunity search.
Name	Name	string	Represents the name of the opportunity used in the search filter.
Amount	Amount	double	Sets the expected revenue or monetary value for the opportunity search filter.
Close Date	CloseDate	string	Represents the close date search filter for opportunities. This property allows filtering opportunities based on their close dates.
Update Date	UpdateDate	date-time	Sets the last update date for the opportunity search filter.
Insert Date	InsertDate	date-time	Sets the date and time when the opportunity was inserted.
Account Id	AccountId	string	Specifies the identifiers for the account filter in the opportunity search criteria.
Forecast Category Id	ForecastCategoryId	string	Filters opportunities based on the specified forecast category identifiers.
Account Source Type Id	AccountSourceTypeId	string	Represents the identifier for the account source type filter in an opportunity search.
Opportunity Status Id	OpportunityStatusId	string	Specifies the identifiers of the opportunity statuses to filter the opportunities search.
Quote Id	QuoteId	string	Sets the unique identifier for the associated quote in the opportunity search filter.
Loss Reason Id	LossReasonId	string	Represents the identifier for the reason an opportunity was lost.
Type Id	TypeId	string	Represents the type identifier used to filter opportunities in a search query.
Last Modified By	LastModifiedBy	string	Specifies the user who last modified the opportunity.
Created By	CreatedBy	string	Specifies the identifier of the user or system that created the opportunity entry.
Search	Search	string	Sets the keyword or phrase used to perform a general search across opportunity records.
Sales Pipeline Id	SalesPipelineId	string	Sets the identifier for the sales pipeline filter in opportunity searches.
Status	Status	string	Specifies the statuses of opportunities for the search filter.
Page	Page	integer	Sets the page number for paginated results. Defaults to 1.
Page Size	PageSize	integer	Sets the number of items per page for paginated results. Defaults to 25.
Sort	Sort	string	Specifies the sort criteria as a string. The sort string determines the property and the direction (ascending or descending) for sorting results. Multiple criteria can be combined using a comma separator.

Returns

response: array of SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Retrieve all tasks accessible to the user

Operation ID:: Task_GetAll

Lists all tasks accessible to the current user.
You can filter results using search criteria such as assigned user, status, or date range.
Useful for reporting, dashboards, or automations that process multiple tasks.

Parameters

Name	Key	Type	Description
Id	Id	string	Sets the unique identifier for the task.
Status	Status	string	Sets the status of the task, representing its current stage such as Open or Completed.
Related To	RelatedTo	string	Sets the related type for filtering tasks. This property is used to associate tasks with a specific entity or category.
Related To Id	RelatedToId	string	Sets the identifier of the entity to which the task is related.
Priority Id	PriorityId	string	Sets the identifier for filtering tasks by their priority.
task Type	Type	string	Sets the type of the task, indicating its intended purpose or category.
Due Date	DueDate	date-time	Sets the due date of the task. This property is used to filter tasks based on their due date.
Sort Date	SortDate	string	Sets the sort date values used for filtering and sorting tasks.
Parent Id	ParentId	string	Sets the identifier of the parent task associated with the current task.
Last Modified By	LastModifiedBy	string	Sets the identifier for the user who last modified the task.
Created By	CreatedBy	string	Sets the identifier of the user who created the task.
Assigned To Id	AssignedToId	string	Sets the identifiers of the users to whom the task is assigned.
Search	Search	string	Sets the search query used to filter tasks based on a specified keyword or text.
Page	Page	integer	Sets the current page number for paginated results. This value is used to determine the starting point of the dataset for pagination.
Page Size	PageSize	integer	Sets the number of items to be included in a single page of paginated results. This value determines the size of the dataset to be returned per page.
Sort	Sort	string	Represents the sorting criteria for the search results. This property defines the sorting order and fields for the dataset.

Returns

response: array of Task.Api.Features.Tasks.TaskDTO

Retrieve an account by ID

Operation ID:: Account_GetById

Returns details for the specified account, including company-specific data.
Access is determined by the company context provided in the x-companyid request header.

Parameters

Name	Key	Required	Type	Description
account Id	accountId	True	string	The unique identifier of the account to retrieve.

Returns

Body: Customer.Api.Features.Accounts.AccountDTO

Retrieve an event by ID

Operation ID:: Event_GetById

Returns detailed information for the specified event, including title, participants, scheduled time, and status.
Use this action to view or reference a specific event in your automation.

Parameters

Name	Key	Required	Type	Description
id	id	True	string	The unique identifier of the event.

Returns

Body: Task.Api.Features.Events.EventDTO

Retrieve an opportunity by ID

Operation ID:: Opportunity_GetById

Returns full details of the specified opportunity, including owner and linked account.
Access is restricted based on user permissions.

Parameters

Name	Key	Required	Type	Description
id	id	True	string	The unique identifier of the opportunity.

Returns

Body: SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Update a call by ID

Operation ID:: Call_Update

Use this action to modify details of an existing call, such as subject, participants, scheduled time, or status.
Only calls accessible to the current user can be updated.

Parameters

Name	Key	Required	Type	Description
id	id	True	string	The unique identifier of the call to update.
task Type	taskType		string
due Date	dueDate		date-time
subject	subject		string
assigned To Type	assignedToType		string
assigned To Id	assignedToId		string
related To Type	relatedToType		string
related To Id	relatedToId		string
contact Type	contactType		string
contact Ids	contactIds		array of string
status	status		string
call Duration	callDuration		date-span
call Result Id	callResultId		string
comments	comments		string
editor Body	editorBody		string
priority Id	priorityId		string
position	position		integer
parent Id	parentId		string
reminder Set	reminderSet		boolean
last Modified By	lastModifiedBy		string
sort Date	sortDate		date-time
source Id	sourceId		string
source Assigned To Id	sourceAssignedToId		string
source Related To Id	sourceRelatedToId		string
source Contact Ids	sourceContactIds		array of string
call Direction	callDirection		string

Returns

Body: Task.Api.Features.Calls.CallDTO

Update a lead by ID

Operation ID:: Lead_Update

Updates details of an existing lead such as company info, contact details, status, or source. Only leads accessible to the user can be updated.

Parameters

Name	Key	Required	Type	Description
id	id	True	string	The unique identifier of the lead to update.
job Title	jobTitle		string
lead Status Id	leadStatusId		string
first Name	firstName	True	string
last Name	lastName		string
middle Name	middleName		string
salutation Id	salutationId		string
suffix	suffix		string
email	email		string
phone	phone		string
mobile Phone	mobilePhone		string
email Address	emailAddress		string
type	type		string
opt Out	optOut		boolean
phone Number	phoneNumber		string
type	type		string
opt Out	optOut		boolean
call Opt Out	callOptOut		boolean
email Opt Out	emailOptOut		boolean
rating Id	ratingId		string
owner Id	ownerId		string
owner Type	ownerType		string
website	website		string
company	company		string
industry Id	industryId		string
no Of Employees	noOfEmployees		integer
account Source Type Id	accountSourceTypeId		string
address1	address1		string
address2	address2		string
city	city		string
state	state		string
country	country		string
postal Code	postalCode		string
description	description		string
annual Revenue	annualRevenue		double
last Transfer Date	lastTransferDate		date-time
gender Id	genderId		string
pronounce Id	pronounceId		string
status	status		string
last Modified By	lastModifiedBy		string
extra Fields	extraFields		object

Returns

Body: SalesPipeline.Api.Features.Lead.LeadDto

Update an existing account

Operation ID:: Account_Update

Updates details for the specified account in the given company.
User permissions and company context are validated during this operation.
Only authorized users with valid data can perform the update.

Parameters

Name	Key	Required	Type	Description
account Id	accountId	True	string	The unique identifier of the account to be updated.
Name	name		string
Phone	phone		string
Tin	tin		string
Code	code		string
Email	email		string
SourceId	sourceId		string
SourceParentId	sourceParentId		string
SourceOwnerId	sourceOwnerId		string
PrimaryContactIds	primaryContactIds		array of string
ParentAccountId	parentAccountId		string
OwnerId	ownerId		string
Address1	address1		string
Address2	address2		string
City	city		string
State	state		string
Latitude	latitude		string
Longtitude	longtitude		string
Country	country		string
CountryCode	countryCode		string
PostalCode	postalCode		string
FirstName	firstName		string
LastName	lastName		string
PhoneNumber	phoneNumber		string
Email	email		string
AccountSourceTypeId	accountSourceTypeId		string
IndustryId	industryId		string
TierId	tierId		string
Website	website		string
AccountDescription	accountDescription		string
NoOfEmployees	noOfEmployees		integer
AnnualRevenue	annualRevenue		double
CreatedBy	createdBy		string
LastModifiedBy	lastModifiedBy		string
Fax	fax		string
OwnershipId	ownershipId		string
RatingId	ratingId		string
ClassificationId	classificationId		string
ExtraFields	extraFields		object
AssignedTeams	assignedTeams		array of string

Returns

Body: Customer.Api.Features.Accounts.AccountDTO

Update an existing contact

Operation ID:: Contact_Update

Updates details for the specified contact in the given company.
User permissions and company context are validated during this operation.

Parameters

Name	Key	Required	Type	Description
contact Id	contactId	True	string	The unique identifier of the contact to update.
OwnerId	ownerId		string
AccountIds	accountIds		array of string
SourceId	sourceId		string
SourceOwnerId	sourceOwnerId		string
SourceAccountIds	sourceAccountIds		array of string
FirstName	firstName		string
LastName	lastName		string
MiddleName	middleName		string
SalutationId	salutationId		string
Suffix	suffix		string
Email	email		string
Phone	phone		string
MobilePhone	mobilePhone		string
Fax	fax		string
CallOptOut	callOptOut		boolean
EmailOptOut	emailOptOut		boolean
EmailAddress	emailAddress		string
Type	type		string
OptOut	optOut		boolean
PhoneNumber	phoneNumber		string
Type	type		string
OptOut	optOut		boolean
JobTitle	jobTitle		string
GenderId	genderId		string
PronounceId	pronounceId		string
Address1	address1		string
Address2	address2		string
City	city		string
State	state		string
Latitude	latitude		string
Longtitude	longtitude		string
Country	country		string
CountryCode	countryCode		string
PostalCode	postalCode		string
FirstName	firstName		string
LastName	lastName		string
PhoneNumber	phoneNumber		string
Email	email		string
CreatedBy	createdBy		string
LastModifiedBy	lastModifiedBy		string
Department	department		string
ReportsTo	reportsTo		string
Assistant	assistant		string
AssistantPhone	assistantPhone		string
Birthday	birthday		date-time
Description	description		string
LastStayInTouchReportedDate	lastStayInTouchReportedDate		date-time
LastStayInTouchSaveDate	lastStayInTouchSaveDate		date-time
AccountSourceTypeId	accountSourceTypeId		string
ExtraFields	extraFields		object
AssignedTeams	assignedTeams		array of string

Returns

Body: Customer.Api.Features.Contacts.ContactDTO

Update an existing event by ID

Operation ID:: Event_Update

Use this action to modify details of an existing event, such as title, description, participants, or scheduled time.
Only events accessible to the current user can be updated.

Parameters

Name	Key	Required	Type	Description
id	id	True	string	The unique identifier of the event to update.
update Date	updateDate		date-time
subject	subject		string
task Type	taskType		string
assigned To Type	assignedToType		string
assigned To Id	assignedToId		string
related To Type	relatedToType		string
related To Id	relatedToId		string
contact Type	contactType		string
contact Ids	contactIds		array of string
description	description		string
editor Body	editorBody		string
priority Id	priorityId		string
longitude	longitude		string
latitude	latitude		string
start Date	startDate		date-time
end Date	endDate		date-time
reminder Set	reminderSet		boolean
created By	createdBy		string
last Modified By	lastModifiedBy		string
position	position		integer
parent Id	parentId		string
repeat	repeat		string
event Status	eventStatus		string
event Result Id	eventResultId		string
recurrence Interval	recurrenceInterval		string
source Id	sourceId		string
source Assigned To Id	sourceAssignedToId		string
source Related To Id	sourceRelatedToId		string
source Contact Ids	sourceContactIds		array of string
team Members	teamMembers		array of string

Returns

Body: Task.Api.Features.Events.EventDTO

Update an existing note by ID

Operation ID:: Note_Update

Use this action to modify details of an existing note, such as content or related references.
Only notes accessible to the current user can be updated.

Parameters

Name	Key	Required	Type	Description
id	id	True	string	The unique identifier of the note to update.
related To Type	relatedToType		string
related To Id	relatedToId		string
subject	subject		string
body	body		string
editor Body	editorBody		string
last Modified By	lastModifiedBy		string
contact Ids	contactIds		array of string
contact Type	contactType		string

Returns

Body: Task.Api.Features.Notes.NoteDTO

Update an existing opportunity by ID

Operation ID:: Opportunity_Update

Applies changes to fields of the specified opportunity, such as name, stage, amount, or account link.
Only accessible if the user has write permissions.

Parameters

Name	Key	Required	Type	Description
id	id	True	string	The unique identifier of the opportunity to update.
type Id	typeId		string
owner Id	ownerId		string
account Id	accountId		string
name	name		string
amount	amount		double
forecast Category Id	forecastCategoryId		string
close Date	closeDate		date-time
probability	probability		integer
score	score		integer
description	description		string
sales Pipeline Id	salesPipelineId		string
quote Id	quoteId		string
opportunity Status Id	opportunityStatusId		string
status	status		string
account Source Type Id	accountSourceTypeId		string
next Step	nextStep		string
budget Confirmed	budgetConfirmed		boolean
discovery Completed	discoveryCompleted		boolean
expected Revenue	expectedRevenue		double
loss Reason Id	lossReasonId		string
private	private		boolean
last Modified By	lastModifiedBy		string
extra Fields	extraFields		object

Returns

Body: SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Update an existing task by ID

Operation ID:: Task_Update

Use this action to modify details of an existing task, such as subject, description, due date, priority, or assigned user.
Only tasks accessible to the current user can be updated.

Parameters

Name	Key	Required	Type	Description
id	id	True	string	The unique identifier of the task to update.
task Type	taskType		string
subject	subject		string
due Date	dueDate		date-time
completed Date	completedDate		date-time
status	status		string
priority Id	priorityId		string
assigned To Id	assignedToId		string
assigned To Type	assignedToType		string
contact Ids	contactIds		array of string
contact Type	contactType		string
related To Id	relatedToId		string
related To Type	relatedToType		string
task Sub Type Id	taskSubTypeId		string
comments	comments		string
editor Body	editorBody		string
reminder Set	reminderSet		boolean
position	position		integer
parent Id	parentId		string
last Modified By	lastModifiedBy		string

Returns

Body: Task.Api.Features.Tasks.TaskDTO

Triggers

Call Created Trigger	Use this action to create a new call activity, including subject, participants, scheduled time, and status. The created call can later be retrieved, updated, or deleted.
Call Deleted Trigger	Permanently removes the specified call from the system. Only calls accessible to the current user can be deleted. Ensure the call is not linked to other processes before deletion.
Call Updated Trigger	Use this action to modify details of an existing call, such as subject, participants, scheduled time, or status. Only calls accessible to the current user can be updated.
Event Created Trigger	Use this action to schedule or log a new event. Provide details such as title, description, participants, and scheduled date/time. The created event can later be updated, retrieved, or linked to other activities.
Event Deleted Trigger	Permanently removes the specified event from the system. Ensure that the event is not linked to other processes before deletion. Only events accessible to the current user can be deleted.
Event Updated Trigger	Use this action to modify details of an existing event, such as title, description, participants, or scheduled time. Only events accessible to the current user can be updated.
Lead Created Trigger	Use this action to create a new lead, including company details, contact information, and source. The created lead can later be enriched, scored, converted, or updated.
Lead Deleted Trigger	Permanently deletes a lead from the system. Ensure the lead is not needed for further processing or conversion before deletion.
Lead Updated Trigger	Updates details of an existing lead such as company info, contact details, status, or source. Only leads accessible to the user can be updated.
Opportunity Created Trigger	Use this action to create a new opportunity in the sales pipeline. An opportunity typically represents a potential deal with an account, linked to a lead or created independently.
Opportunity Deleted Trigger	Permanently removes an opportunity from the system. Ensure the opportunity is no longer needed before deletion, as the action cannot be undone.
Opportunity Updated Trigger	Applies changes to fields of the specified opportunity, such as name, stage, amount, or account link. Only accessible if the user has write permissions.
Task Created Trigger	Use this action to add a new task to your system. Provide details such as subject, description, due date, priority, and assigned user. The created task can later be retrieved, updated, or deleted.
Task Deleted Trigger	Permanently removes the specified task from the system. Ensure that the task is not linked to other processes before deletion. Only tasks accessible to the current user can be deleted.
Task Updated Trigger	Use this action to modify details of an existing task, such as subject, description, due date, priority, or assigned user. Only tasks accessible to the current user can be updated.

Call Created Trigger

Operation ID:: Call_Created

Use this action to create a new call activity, including subject, participants, scheduled time, and status.
The created call can later be retrieved, updated, or deleted.

Parameters

Name	Key	Required	Type	Description
Title	Title	True	string	A title for the webhook registration

Returns

Body: Task.Api.Features.Calls.CallDTO

Call Deleted Trigger

Operation ID:: Call_Deleted

Permanently removes the specified call from the system.
Only calls accessible to the current user can be deleted.
Ensure the call is not linked to other processes before deletion.

Parameters

Name	Key	Required	Type	Description
Title	Title	True	string	A title for the webhook registration

Returns

Body: Task.Api.Features.Calls.CallDTO

Call Updated Trigger

Operation ID:: Call_Updated

Use this action to modify details of an existing call, such as subject, participants, scheduled time, or status.
Only calls accessible to the current user can be updated.

Parameters

Name	Key	Required	Type	Description
Title	Title	True	string	A title for the webhook registration

Returns

Body: Task.Api.Features.Calls.CallDTO

Event Created Trigger

Operation ID:: Event_Created

Parameters

Name	Key	Required	Type	Description
Title	Title	True	string	A title for the webhook registration

Returns

Body: Task.Api.Features.Events.EventDTO

Event Deleted Trigger

Operation ID:: Event_Deleted

Permanently removes the specified event from the system.
Ensure that the event is not linked to other processes before deletion.
Only events accessible to the current user can be deleted.

Parameters

Name	Key	Required	Type	Description
Title	Title	True	string	A title for the webhook registration

Returns

Body: Task.Api.Features.Events.EventDTO

Event Updated Trigger

Operation ID:: Event_Updated

Use this action to modify details of an existing event, such as title, description, participants, or scheduled time.
Only events accessible to the current user can be updated.

Parameters

Name	Key	Required	Type	Description
Title	Title	True	string	A title for the webhook registration

Returns

Body: Task.Api.Features.Events.EventDTO

Lead Created Trigger

Operation ID:: Lead_Created

Use this action to create a new lead, including company details, contact information, and source. The created lead can later be enriched, scored, converted, or updated.

Parameters

Name	Key	Required	Type	Description
Title	Title	True	string	A title for the webhook registration

Returns

Body: SalesPipeline.Api.Features.Lead.LeadDto

Lead Deleted Trigger

Operation ID:: Lead_Deleted

Permanently deletes a lead from the system. Ensure the lead is not needed for further processing or conversion before deletion.

Parameters

Name	Key	Required	Type	Description
Title	Title	True	string	A title for the webhook registration

Returns

Body: SalesPipeline.Api.Features.Lead.LeadDto

Lead Updated Trigger

Operation ID:: Lead_Updated

Updates details of an existing lead such as company info, contact details, status, or source. Only leads accessible to the user can be updated.

Parameters

Name	Key	Required	Type	Description
Title	Title	True	string	A title for the webhook registration

Returns

Body: SalesPipeline.Api.Features.Lead.LeadDto

Opportunity Created Trigger

Operation ID:: Opportunity_Created

Use this action to create a new opportunity in the sales pipeline.
An opportunity typically represents a potential deal with an account, linked to a lead or created independently.

Parameters

Name	Key	Required	Type	Description
Title	Title	True	string	A title for the webhook registration

Returns

Body: SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Opportunity Deleted Trigger

Operation ID:: Opportunity_Deleted

Permanently removes an opportunity from the system.
Ensure the opportunity is no longer needed before deletion, as the action cannot be undone.

Parameters

Name	Key	Required	Type	Description
Title	Title	True	string	A title for the webhook registration

Returns

Body: SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Opportunity Updated Trigger

Operation ID:: Opportunity_Updated

Applies changes to fields of the specified opportunity, such as name, stage, amount, or account link.
Only accessible if the user has write permissions.

Parameters

Name	Key	Required	Type	Description
Title	Title	True	string	A title for the webhook registration

Returns

Body: SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Task Created Trigger

Operation ID:: Task_Created

Use this action to add a new task to your system.
Provide details such as subject, description, due date, priority, and assigned user.
The created task can later be retrieved, updated, or deleted.

Parameters

Name	Key	Required	Type	Description
Title	Title	True	string	A title for the webhook registration

Returns

Body: Task.Api.Features.Tasks.TaskDTO

Task Deleted Trigger

Operation ID:: Task_Deleted

Permanently removes the specified task from the system.
Ensure that the task is not linked to other processes before deletion.
Only tasks accessible to the current user can be deleted.

Parameters

Name	Key	Required	Type	Description
Title	Title	True	string	A title for the webhook registration

Returns

Body: Task.Api.Features.Tasks.TaskDTO

Task Updated Trigger

Operation ID:: Task_Updated

Use this action to modify details of an existing task, such as subject, description, due date, priority, or assigned user.
Only tasks accessible to the current user can be updated.

Parameters

Name	Key	Required	Type	Description
Title	Title	True	string	A title for the webhook registration

Returns

Body: Task.Api.Features.Tasks.TaskDTO

Definitions

Task.Api.Features.Calls.CallDTO

Name	Path	Type
id	id	string
companyId	companyId	string
insertDate	insertDate	date-time
updateDate	updateDate	date-time
task Type	taskType	Task.Api.Models.Enums.TaskType
dueDate	dueDate	date-time
subject	subject	string
assigned To Type	assignedToType	Task.Api.Models.Enums.AssignedToType
assignedToId	assignedToId	string
related To Type	relatedToType	Task.Api.Models.Enums.RelatedToType
relatedToId	relatedToId	string
contact Type	contactType	Task.Api.Models.Enums.ContactType
contactIds	contactIds	array of string
status	status	Task.Api.Models.Enums.Status
callDuration	callDuration	date-span
callResultId	callResultId	string
comments	comments	string
editorBody	editorBody	string
priorityId	priorityId	string
lastModifiedBy	lastModifiedBy	string
createdBy	createdBy	string
position	position	integer
parentId	parentId	string
reminderSet	reminderSet	boolean
sortDate	sortDate	date-time
sourceId	sourceId	string
sourceAssignedToId	sourceAssignedToId	string
sourceRelatedToId	sourceRelatedToId	string
sourceContactIds	sourceContactIds	array of string
call Direction	callDirection	Task.Api.Models.Enums.CallDirection

Task.Api.Features.Events.EventDTO

Name	Path	Type
id	id	string
companyId	companyId	string
insertDate	insertDate	date-time
updateDate	updateDate	date-time
subject	subject	string
task Type	taskType	Task.Api.Models.Enums.TaskType
assigned To Type	assignedToType	Task.Api.Models.Enums.AssignedToType
assignedToId	assignedToId	string
related To Type	relatedToType	Task.Api.Models.Enums.RelatedToType
relatedToId	relatedToId	string
contact Type	contactType	Task.Api.Models.Enums.ContactType
contactIds	contactIds	array of string
description	description	string
editorBody	editorBody	string
priorityId	priorityId	string
location	location	Task.Api.Features.Events.LocationDTO
startDate	startDate	date-time
endDate	endDate	date-time
reminderSet	reminderSet	boolean
createdBy	createdBy	string
lastModifiedBy	lastModifiedBy	string
position	position	integer
parentId	parentId	string
repeat	repeat	string
event Status	eventStatus	Task.Api.Models.Enums.EventStatus
eventResultId	eventResultId	string
recurrenceInterval	recurrenceInterval	string
sourceId	sourceId	string
sourceAssignedToId	sourceAssignedToId	string
sourceRelatedToId	sourceRelatedToId	string
sourceContactIds	sourceContactIds	array of string
teamMembers	teamMembers	array of string

Task.Api.Features.Events.LocationDTO

Name	Path	Type	Description
longitude	longitude	string
latitude	latitude	string

Task.Api.Features.Notes.NoteDTO

Name	Path	Type
id	id	string
companyId	companyId	string
related To Type	relatedToType	Task.Api.Models.Enums.RelatedToType
relatedToId	relatedToId	string
subject	subject	string
createdBy	createdBy	string
lastModifiedBy	lastModifiedBy	string
body	body	string
editorBody	editorBody	string
insertDate	insertDate	date-time
updateDate	updateDate	date-time
contactIds	contactIds	array of string
contact Type	contactType	Task.Api.Models.Enums.ContactType
task Type	taskType	Task.Api.Models.Enums.TaskType
sortDate	sortDate	date-time

Task.Api.Features.Tasks.TaskDTO

Name	Path	Type
id	id	string
companyId	companyId	string
insertDate	insertDate	date-time
updateDate	updateDate	date-time
createdBy	createdBy	string
lastModifiedBy	lastModifiedBy	string
task Type	taskType	Task.Api.Models.Enums.TaskType
subject	subject	string
dueDate	dueDate	date-time
completedDate	completedDate	date-time
status	status	Task.Api.Models.Enums.Status
priorityId	priorityId	string
assignedToId	assignedToId	string
assigned To Type	assignedToType	Task.Api.Models.Enums.AssignedToType
contactIds	contactIds	array of string
contact Type	contactType	Task.Api.Models.Enums.ContactType
relatedToId	relatedToId	string
related To Type	relatedToType	Task.Api.Models.Enums.RelatedToType
taskSubTypeId	taskSubTypeId	string
comments	comments	string
editorBody	editorBody	string
reminderSet	reminderSet	boolean
position	position	integer
parentId	parentId	string

Task.Api.Models.Enums.AssignedToType

assigned To Type: string

Task.Api.Models.Enums.CallDirection

call Direction: string

Task.Api.Models.Enums.ContactType

contact Type: string

Task.Api.Models.Enums.EventStatus

event Status: string

Task.Api.Models.Enums.RelatedToType

related To Type: string

Task.Api.Models.Enums.Status

status: string

Task.Api.Models.Enums.TaskType

task Type: string

SalesPipeline.Api.DTOs.AddressDto

Name	Path	Type
address1	address1	string
address2	address2	string
city	city	string
state	state	string
country	country	string
postal Code	postalCode	string

SalesPipeline.Api.DTOs.EmailDTO

Name	Path	Type
email Address	emailAddress	string
type	type	SalesPipeline.Api.Models.Enums.EmailType
opt Out	optOut	boolean

SalesPipeline.Api.DTOs.NameDTO

Name	Path	Type
first Name	firstName	string
last Name	lastName	string
middle Name	middleName	string
salutation Id	salutationId	string
suffix	suffix	string

SalesPipeline.Api.DTOs.PhoneDTO

Name	Path	Type
phone Number	phoneNumber	string
type	type	SalesPipeline.Api.Models.Enums.PhoneType
opt Out	optOut	boolean

SalesPipeline.Api.Features.Lead.LeadDto

Name	Path	Type
id	id	string
companyId	companyId	string
jobTitle	jobTitle	string
leadStatusId	leadStatusId	string
name	name	SalesPipeline.Api.DTOs.NameDTO
email	email	string
phone	phone	string
mobilePhone	mobilePhone	string
otherEmail	otherEmail	array of SalesPipeline.Api.DTOs.EmailDTO
otherPhone	otherPhone	array of SalesPipeline.Api.DTOs.PhoneDTO
callOptOut	callOptOut	boolean
emailOptOut	emailOptOut	boolean
ratingId	ratingId	string
insertDate	insertDate	date-time
updateDate	updateDate	date-time
ownerId	ownerId	string
owner Type	ownerType	SalesPipeline.Api.Models.Enums.OwnerType
website	website	string
company	company	string
industryId	industryId	string
noOfEmployees	noOfEmployees	integer
accountSourceTypeId	accountSourceTypeId	string
address	address	SalesPipeline.Api.DTOs.AddressDto
description	description	string
createdBy	createdBy	string
lastModifiedBy	lastModifiedBy	string
annualRevenue	annualRevenue	double
lastTransferDate	lastTransferDate	date-time
genderId	genderId	string
pronounceId	pronounceId	string
fullName	fullName	string
status	status	SalesPipeline.Api.Models.Enums.Status
extraFields	extraFields	object
aiScore	aiScore	double
aiScoreReasoning	aiScoreReasoning	string
aiSentiment	aiSentiment	SalesPipeline.Api.Features.Lead.UpdateLeadScore.LeadSentiment
aiGenerationDate	aiGenerationDate	date-time

SalesPipeline.Api.Features.Lead.UpdateLeadScore.LeadSentiment

: string

SalesPipeline.Api.Features.Opportunity.OpportunityDTO

Name	Path	Type
id	id	string
companyId	companyId	string
accountId	accountId	string
typeId	typeId	string
ownerId	ownerId	string
name	name	string
amount	amount	double
forecastCategoryId	forecastCategoryId	string
salesPipelineId	salesPipelineId	string
insertDate	insertDate	date-time
updateDate	updateDate	date-time
closeDate	closeDate	date-time
probability	probability	integer
score	score	integer
description	description	string
quoteId	quoteId	string
opportunityStatusId	opportunityStatusId	string
status	status	SalesPipeline.Api.Models.Enums.OpportunityStatus
accountSourceTypeId	accountSourceTypeId	string
nextStep	nextStep	string
budgetConfirmed	budgetConfirmed	boolean
discoveryCompleted	discoveryCompleted	boolean
expectedRevenue	expectedRevenue	double
lossReasonId	lossReasonId	string
private	private	boolean
createdBy	createdBy	string
lastModifiedBy	lastModifiedBy	string
extraFields	extraFields	object
aiScore	aiScore	double
aiScoreReasoning	aiScoreReasoning	string
aiSentiment	aiSentiment	SalesPipeline.Api.Features.Opportunity.UpdateOpportunityScore.OpportunitySentiment
aiGenerationDate	aiGenerationDate	date-time

SalesPipeline.Api.Features.Opportunity.UpdateOpportunityScore.OpportunitySentiment

: string

SalesPipeline.Api.Models.Enums.EmailType

type: string

SalesPipeline.Api.Models.Enums.OpportunityStatus

status: string

SalesPipeline.Api.Models.Enums.OwnerType

owner Type: string

SalesPipeline.Api.Models.Enums.PhoneType

type: string

SalesPipeline.Api.Models.Enums.Status

status: string

Identity.Api.BackOfficeUsers.GetUser.GetUserResponse

Name	Path	Type	Description
id	id	string	The user identifier
email	email	string	The user email.
firstName	firstName	string	The user first name.
lastName	lastName	string	The user last name
fullName	fullName	string	The user full name
userRole	userRole	Identity.Api.BackOfficeUsers.GetUser.GetUserResponse_Role
profileImage	profileImage	Identity.Api.BackOfficeUsers.GetUser.GetUserResponse_Image
lastLogin	lastLogin	date-time	The users last login date. Could be null if user have never logged in
insertDate	insertDate	date-time	The creation date of the user
updateDate	updateDate	date-time	The last update date of the user.

Identity.Api.BackOfficeUsers.GetUser.GetUserResponse_Image

Name	Path	Type	Description
id	id	string
galleryId	galleryId	string	The id stored in gallery
alt	alt	string	The alt to show
link	link	string	The url of the image

Identity.Api.BackOfficeUsers.GetUser.GetUserResponse_Role

Name	Path	Type	Description
companyId	companyId	string	The company id for the role, this will always be the company id that you requested the users for.
isAdmin	isAdmin	boolean	Whether this user is considered an admin in the current company.
roleId	roleId	string	The role id if the user is not an admin. When the user is admin the role id will be missing.

Identity.Api.Teams.Dtos.GetTeamResponse

Name	Path	Type
id	id	string
name	name	string
users	users	array of Identity.Api.Teams.Dtos.TeamUserDto
modifiedBy	modifiedBy	string
createdBy	createdBy	string
createdAt	createdAt	date-time
modifiedAt	modifiedAt	date-time

Identity.Api.Teams.Dtos.TeamUserDto

Name	Path	Type	Description
id	id	string

Customer.Api.DTOs.AddressDTO

Name	Path	Type
Address1	address1	string
Address2	address2	string
City	city	string
State	state	string
Latitude	latitude	string
Longtitude	longtitude	string
Country	country	string
CountryCode	countryCode	string
PostalCode	postalCode	string
FirstName	firstName	string
LastName	lastName	string
PhoneNumber	phoneNumber	string
Email	email	string

Customer.Api.Features.Accounts.AccountDTO

Name	Path	Type
Id	id	string
CompanyId	companyId	string
Name	name	string
Code	code	string
Tin	tin	string
Email	email	string
Phone	phone	string
SourceId	sourceId	string
SourceParentId	sourceParentId	string
SourceOwnerId	sourceOwnerId	string
PrimaryContactIds	primaryContactIds	array of string
ParentAccountId	parentAccountId	string
OwnerId	ownerId	string
address	address	Customer.Api.DTOs.AddressDTO
UpdateDate	updateDate	date-time
InsertDate	insertDate	date-time
TaxOffice	taxOffice	string
AccountSourceTypeId	accountSourceTypeId	string
IndustryId	industryId	string
TierId	tierId	string
Website	website	string
AccountDescription	accountDescription	string
NoOfEmployees	noOfEmployees	integer
AnnualRevenue	annualRevenue	double
CreatedBy	createdBy	string
LastModifiedBy	lastModifiedBy	string
Fax	fax	string
OwnershipId	ownershipId	string
RatingId	ratingId	string
ClassificationId	classificationId	string
ExtraFields	extraFields	object
AssignedTeams	assignedTeams	array of string
AiScore	aiScore	double
AiScoreReasoning	aiScoreReasoning	string
AiSentiment	aiSentiment	integer
AiGenerationDate	aiGenerationDate	date-time

Customer.Api.Features.Contacts.Contact

Name	Path	Type
Id	id	string
CompanyId	companyId	string
PartitionKey	partitionKey	string
OwnerId	ownerId	string
AccountIds	accountIds	array of string
SourceId	sourceId	string
SourceAccountIds	sourceAccountIds	array of string
SourceOwnerId	sourceOwnerId	string
name	name	Customer.Api.Features.Contacts.Name
Email	email	string
Phone	phone	string
MobilePhone	mobilePhone	string
Fax	fax	string
CallOptOut	callOptOut	boolean
EmailOptOut	emailOptOut	boolean
OtherEmail	otherEmail	array of Customer.Api.Features.Contacts.Email
OtherPhone	otherPhone	array of Customer.Api.Features.Contacts.Phone
JobTitle	jobTitle	string
GenderId	genderId	string
PronounceId	pronounceId	string
address	address	Customer.Api.Models.Address
InsertDate	insertDate	date-time
UpdateDate	updateDate	date-time
CreatedBy	createdBy	string
LastModifiedBy	lastModifiedBy	string
Department	department	string
ReportsTo	reportsTo	string
Assistant	assistant	string
AssistantPhone	assistantPhone	string
Birthday	birthday	date-time
Description	description	string
LastStayInTouchReportedDate	lastStayInTouchReportedDate	date-time
LastStayInTouchSaveDate	lastStayInTouchSaveDate	date-time
AccountSourceTypeId	accountSourceTypeId	string
ExtraFields	extraFields	object
SearchTags	searchTags	array of string
AssignedTeams	assignedTeams	array of string

Customer.Api.Features.Contacts.ContactDTO

Name	Path	Type
Id	id	string
CompanyId	companyId	string
OwnerId	ownerId	string
AccountIds	accountIds	array of string
SourceId	sourceId	string
SourceOwnerId	sourceOwnerId	string
SourceAccountIds	sourceAccountIds	array of string
name	name	Customer.Api.Features.Contacts.NameDTO
Email	email	string
Phone	phone	string
MobilePhone	mobilePhone	string
Fax	fax	string
CallOptOut	callOptOut	boolean
EmailOptOut	emailOptOut	boolean
OtherEmail	otherEmail	array of Customer.Api.Features.Contacts.EmailDTO
OtherPhone	otherPhone	array of Customer.Api.Features.Contacts.PhoneDTO
JobTitle	jobTitle	string
GenderId	genderId	string
PronounceId	pronounceId	string
address	address	Customer.Api.DTOs.AddressDTO
InsertDate	insertDate	date-time
UpdateDate	updateDate	date-time
CreatedBy	createdBy	string
LastModifiedBy	lastModifiedBy	string
Department	department	string
ReportsTo	reportsTo	string
Assistant	assistant	string
AssistantPhone	assistantPhone	string
Birthday	birthday	date-time
Description	description	string
LastStayInTouchReportedDate	lastStayInTouchReportedDate	date-time
LastStayInTouchSaveDate	lastStayInTouchSaveDate	date-time
AccountSourceTypeId	accountSourceTypeId	string
FullName	fullName	string
ExtraFields	extraFields	object
AssignedTeams	assignedTeams	array of string

Customer.Api.Features.Contacts.Email

Name	Path	Type
EmailAddress	emailAddress	string
Type	type	string
OptOut	optOut	boolean

Customer.Api.Features.Contacts.EmailDTO

Name	Path	Type
EmailAddress	emailAddress	string
Type	type	string
OptOut	optOut	boolean

Customer.Api.Features.Contacts.Name

Name	Path	Type
FirstName	firstName	string
LastName	lastName	string
MiddleName	middleName	string
SalutationId	salutationId	string
Suffix	suffix	string

Customer.Api.Features.Contacts.NameDTO

Name	Path	Type
FirstName	firstName	string
LastName	lastName	string
MiddleName	middleName	string
SalutationId	salutationId	string
Suffix	suffix	string

Customer.Api.Features.Contacts.Phone

Name	Path	Type
PhoneNumber	phoneNumber	string
Type	type	string
OptOut	optOut	boolean

Customer.Api.Features.Contacts.PhoneDTO

Name	Path	Type
PhoneNumber	phoneNumber	string
Type	type	string
OptOut	optOut	boolean

Customer.Api.Models.Address

Name	Path	Type
FirstName	firstName	string
LastName	lastName	string
PhoneNumber	phoneNumber	string
Email	email	string
Address1	address1	string
Address2	address2	string
City	city	string
State	state	string
Latitude	latitude	string
Longtitude	longtitude	string
Country	country	string
PostalCode	postalCode	string
CountryCode	countryCode	string

Share via

Softone Web CRM (Preview)

Softone Web CRM Power Automate Connector

Publisher: Softone Technologies S.A.

Prerequisites

How to get credentials

Get started with your connector

Common errors and remedies

Error 1: Invalid API Key

Error 2: Unable to Connect

Error 3: Missing Permissions

Error 4: Connector Installation Issues

Error 5: Unexpected Behavior

Error 6: Slow Performance

FAQ

How can I get support if I encounter issues or have questions?

What are the key benefits of using Softone Web CRM?

Deployment Instructions

Creating a connection

Default

Throttling Limits

Actions

Create a new account

Parameters

Returns

Create a new call

Parameters

Returns

Create a new contact

Parameters

Returns

Create a new event

Parameters

Returns

Create a new lead

Parameters

Returns

Create a new note

Parameters

Returns

Create a new opportunity

Parameters

Returns

Create a new task

Parameters

Returns

Delete a call by ID

Parameters

Delete a contact

Parameters

Delete a lead by ID

Parameters

Delete a note by ID

Parameters

Delete a task by ID

Parameters

Delete an account

Parameters

Delete an event by ID

Parameters

Delete an opportunity by ID

Parameters

Retrieve a backoffice user by ID

Parameters

Returns

Retrieve a call task by ID

Parameters

Returns

Retrieve a contact by ID

Parameters

Returns

Retrieve a lead by ID

Parameters

Returns

Retrieve a note by ID

Parameters

Returns

Retrieve a task by ID

Parameters

Returns