Documentation Index Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /freshsales-activities | Type: Application | PCID required: Yesfreshsales_activities_create_appointment Create an appointment
Parameters: Parameter Type Required Default Description appointmentobject Yes — Appointment 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}).
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "appointment" : { "type" : "object" , "description" : "Appointment 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})." } }, "required" : [ "PCID" , "appointment" ] }
freshsales_activities_create_document_link Attach a URL link to a CRM record
Parameters: Parameter Type Required Default Description document_linkobject Yes — Link 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).
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "document_link" : { "type" : "object" , "description" : "Link 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)." } }, "required" : [ "PCID" , "document_link" ] }
freshsales_activities_create_file Attach a file to a CRM record
Parameters: Parameter Type Required Default Description documentobject Yes — File 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).
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "document" : { "type" : "object" , "description" : "File 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)." } }, "required" : [ "PCID" , "document" ] }
freshsales_activities_create_note Create a note
Parameters: Parameter Type Required Default Description noteobject Yes — Note fields. Common keys: description (required), targetable_type (‘Contact’, ‘SalesAccount’, or ‘Deal’), targetable_id, creater_id.
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "note" : { "type" : "object" , "description" : "Note fields. Common keys: description (required), targetable_type ('Contact', 'SalesAccount', or 'Deal'), targetable_id, creater_id." } }, "required" : [ "PCID" , "note" ] }
freshsales_activities_create_sales_activity Create a sales activity
Parameters: Parameter Type Required Default Description sales_activityobject Yes — Sales 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).
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "sales_activity" : { "type" : "object" , "description" : "Sales 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)." } }, "required" : [ "PCID" , "sales_activity" ] }
freshsales_activities_create_task Create a task
Parameters: Parameter Type Required Default Description taskobject Yes — Task 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.
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "task" : { "type" : "object" , "description" : "Task 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." } }, "required" : [ "PCID" , "task" ] }
freshsales_activities_delete_appointment Delete an appointment
Parameters: Parameter Type Required Default Description idinteger Yes — Numeric ID of the appointment.
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "Numeric ID of the appointment." } }, "required" : [ "PCID" , "id" ] }
freshsales_activities_delete_note Delete a note
Parameters: Parameter Type Required Default Description idinteger Yes — Numeric ID of the note.
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "Numeric ID of the note." } }, "required" : [ "PCID" , "id" ] }
freshsales_activities_delete_sales_activity Delete a sales activity
Parameters: Parameter Type Required Default Description idinteger Yes — Numeric ID of the sales activity.
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "Numeric ID of the sales activity." } }, "required" : [ "PCID" , "id" ] }
freshsales_activities_delete_task Delete a task
Parameters: Parameter Type Required Default Description idinteger Yes — Numeric ID of the task.
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "Numeric ID of the task." } }, "required" : [ "PCID" , "id" ] }
freshsales_activities_get_appointment Get an appointment by ID
Parameters: Parameter Type Required Default Description idinteger Yes — Numeric ID of the appointment.
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "Numeric ID of the appointment." } }, "required" : [ "PCID" , "id" ] }
freshsales_activities_get_sales_activity Get a sales activity by ID
Parameters: Parameter Type Required Default Description idinteger Yes — Numeric ID of the sales activity.
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "Numeric ID of the sales activity." } }, "required" : [ "PCID" , "id" ] }
freshsales_activities_get_task Get a task by ID
Parameters: Parameter Type Required Default Description idinteger Yes — Numeric ID of the task.
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "Numeric ID of the task." } }, "required" : [ "PCID" , "id" ] }
freshsales_activities_list_appointments List appointments
Parameters: Parameter Type Required Default Description filterstring No — Filter appointments by time range. includestring No — Comma-separated list of associations to side-load (e.g., “creater,targetable,appointment_attendees”). pageinteger No — Page number for paginated results (default 1).
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "filter" : { "type" : "string" , "description" : "Filter appointments by time range." , "enum" : [ "upcoming" , "past" , "all" ] }, "include" : { "type" : "string" , "description" : "Comma-separated list of associations to side-load (e.g., \" creater,targetable,appointment_attendees \" )." }, "page" : { "type" : "integer" , "description" : "Page number for paginated results (default 1)." } }, "required" : [ "PCID" ] }
List files and links for a contact
Parameters: Parameter Type Required Default Description idinteger Yes — Numeric ID of the contact.
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "Numeric ID of the contact." } }, "required" : [ "PCID" , "id" ] }
freshsales_activities_list_sales_activities List sales activities
Parameters: Parameter Type Required Default Description pageinteger No — Page number for paginated results (default 1). includestring No — Comma-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”).
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "page" : { "type" : "integer" , "description" : "Page number for paginated results (default 1)." }, "include" : { "type" : "string" , "description" : "Comma-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 \" )." } }, "required" : [ "PCID" ] }
freshsales_activities_list_sales_activity_fields List sales activity field definitions
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" } }, "required" : [ "PCID" ] }
freshsales_activities_list_tasks List tasks
Parameters: Parameter Type Required Default Description filterstring No — Filter tasks by status. includestring No — Comma-separated list of associations to side-load (e.g., “owner,targetable,users,creater,updater”). pageinteger No — Page number for paginated results (default 1).
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "filter" : { "type" : "string" , "description" : "Filter tasks by status." , "enum" : [ "open" , "due today" , "due tomorrow" , "overdue" , "completed" , "all" ] }, "include" : { "type" : "string" , "description" : "Comma-separated list of associations to side-load (e.g., \" owner,targetable,users,creater,updater \" )." }, "page" : { "type" : "integer" , "description" : "Page number for paginated results (default 1)." } }, "required" : [ "PCID" ] }
freshsales_activities_log_phone_call Log a phone call
Parameters: Parameter Type Required Default Description phone_callobject Yes — Phone 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.
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "phone_call" : { "type" : "object" , "description" : "Phone 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." } }, "required" : [ "PCID" , "phone_call" ] }
freshsales_activities_update_appointment Update an appointment
Parameters: Parameter Type Required Default Description idinteger Yes — Numeric ID of the appointment. appointmentobject Yes — Partial appointment fields to update.
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "Numeric ID of the appointment." }, "appointment" : { "type" : "object" , "description" : "Partial appointment fields to update." } }, "required" : [ "PCID" , "id" , "appointment" ] }
freshsales_activities_update_note Update a note
Parameters: Parameter Type Required Default Description idinteger Yes — Numeric ID of the note. noteobject Yes — Partial note fields to update. Typically used to edit description.
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "Numeric ID of the note." }, "note" : { "type" : "object" , "description" : "Partial note fields to update. Typically used to edit description." } }, "required" : [ "PCID" , "id" , "note" ] }
freshsales_activities_update_sales_activity Update a sales activity
Parameters: Parameter Type Required Default Description idinteger Yes — Numeric ID of the sales activity. sales_activityobject Yes — Partial sales-activity fields to update.
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "Numeric ID of the sales activity." }, "sales_activity" : { "type" : "object" , "description" : "Partial sales-activity fields to update." } }, "required" : [ "PCID" , "id" , "sales_activity" ] }
freshsales_activities_update_task Update a task
Parameters: Parameter Type Required Default Description idinteger Yes — Numeric ID of the task. taskobject Yes — Partial task fields to update. Set status: 1 to mark the task completed.
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "Numeric ID of the task." }, "task" : { "type" : "object" , "description" : "Partial task fields to update. Set status: 1 to mark the task completed." } }, "required" : [ "PCID" , "id" , "task" ] }
