Skip to main content
Server path: /freshsales-activities | Type: Application | PCID required: Yes

Tools


freshsales_activities_create_appointment

Create an appointment Parameters:
ParameterTypeRequiredDefaultDescription
appointmentobjectYesAppointment fields. Common keys: title (required), description, from_date, end_date, location, is_allday, time_zone, outcome_id, conference_id, creater_id, owner_id, targetable_type, targetable_id, appointment_attendees_attributes (array of {attendee_type, attendee_id}).

Attach a URL link to a CRM record Parameters:
ParameterTypeRequiredDefaultDescription
document_linkobjectYesLink fields. Common keys: url (required), targetable_type (‘Contact’, ‘SalesAccount’, or ‘Deal’), targetable_id (integer — ID of the record to attach to), name (optional display name).

freshsales_activities_create_file

Attach a file to a CRM record Parameters:
ParameterTypeRequiredDefaultDescription
documentobjectYesFile fields. Common keys: name (required), url (required — the file URL), targetable_type (‘Contact’, ‘SalesAccount’, or ‘Deal’), targetable_id (integer — ID of the record to attach to).

freshsales_activities_create_note

Create a note Parameters:
ParameterTypeRequiredDefaultDescription
noteobjectYesNote fields. Common keys: description (required), targetable_type (‘Contact’, ‘SalesAccount’, or ‘Deal’), targetable_id, creater_id.

freshsales_activities_create_sales_activity

Create a sales activity Parameters:
ParameterTypeRequiredDefaultDescription
sales_activityobjectYesSales activity fields. Common keys: title (required), sales_activity_type_id (required — from listSalesActivityTypes), targetable_type (‘Contact’ | ‘SalesAccount’ | ‘Deal’), targetable_id, owner_id, start_date, end_date, location, notes, latitude, longitude, outcome_id, custom_field (object of cf_* keys).

freshsales_activities_create_task

Create a task Parameters:
ParameterTypeRequiredDefaultDescription
taskobjectYesTask fields. Common keys: title (required), description, due_date (ISO-8601), owner_id, status (0 = open, 1 = completed), targetable_type (e.g., ‘Contact’, ‘SalesAccount’, ‘Deal’), targetable_id, task_type_id, outcome_id, creater_id, workflow_id. Either targetable (with type + id) or top-level targetable_type + targetable_id is used.

freshsales_activities_delete_appointment

Delete an appointment Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the appointment.

freshsales_activities_delete_note

Delete a note Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the note.

freshsales_activities_delete_sales_activity

Delete a sales activity Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the sales activity.

freshsales_activities_delete_task

Delete a task Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the task.

freshsales_activities_get_appointment

Get an appointment by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the appointment.

freshsales_activities_get_sales_activity

Get a sales activity by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the sales activity.

freshsales_activities_get_task

Get a task by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the task.

freshsales_activities_list_appointments

List appointments Parameters:
ParameterTypeRequiredDefaultDescription
filterstringNoFilter appointments by time range.
includestringNoComma-separated list of associations to side-load (e.g., “creater,targetable,appointment_attendees”).
pageintegerNoPage number for paginated results (default 1).

freshsales_activities_list_contact_document_associations

List files and links for a contact Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the contact.

freshsales_activities_list_sales_activities

List sales activities Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for paginated results (default 1).
includestringNoComma-separated list of associated resources to side-load into the response. Valid values depend on the parent entity (e.g., for contacts: “creater,owner,updater,salesActivities,phoneNumbers,emails,tasks,appointments,notes”).

freshsales_activities_list_sales_activity_fields

List sales activity field definitions

freshsales_activities_list_tasks

List tasks Parameters:
ParameterTypeRequiredDefaultDescription
filterstringNoFilter tasks by status.
includestringNoComma-separated list of associations to side-load (e.g., “owner,targetable,users,creater,updater”).
pageintegerNoPage number for paginated results (default 1).

freshsales_activities_log_phone_call

Log a phone call Parameters:
ParameterTypeRequiredDefaultDescription
phone_callobjectYesPhone call log fields. Common keys: phone_number, note, call_direction (‘incoming’ or ‘outgoing’), outcome_id, targetable_type, targetable_id, from_date, to_date, duration, recording_url, creater_id.

freshsales_activities_update_appointment

Update an appointment Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the appointment.
appointmentobjectYesPartial appointment fields to update.

freshsales_activities_update_note

Update a note Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the note.
noteobjectYesPartial note fields to update. Typically used to edit description.

freshsales_activities_update_sales_activity

Update a sales activity Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the sales activity.
sales_activityobjectYesPartial sales-activity fields to update.

freshsales_activities_update_task

Update a task Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the task.
taskobjectYesPartial task fields to update. Set status: 1 to mark the task completed.