Skip to main content
Fireberry logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 124
  • Triggers: 0
  • Slug: FIREBERRY
  • Version: 20261101_00

Tools

Slug: FIREBERRY_CREATE_A_COMPETITORTool to create a new competitor in Fireberry. Use when you need to track competitive companies, including their products, SWOT analysis, revenue, and contact information.

Input Parameters

string
Opportunities from the SWOT model analysis for this competitor.
string
Strengths from the SWOT model analysis for this competitor.
string
Threats from the SWOT model analysis for this competitor.
string
Weaknesses from the SWOT model analysis for this competitor.
string
The GUID of the system user who created the record. Can be set manually and will be used for permissions.
number
Revenue of the competitor, precision set to .00. Must be non-negative.
string
Name of the competitive product offered by this competitor.
string
Website of the competitor in URL format.
string
Description of up to 4,000 characters providing details about the competitor.
string
Shipping city for the competitor’s address.
string
Shipping state for the competitor’s address.
string
required
Name of the competitor (Primary field, required). This is the main identifier for the competitor.
string
Shipping street address for the competitor.
string
Shipping country for the competitor’s address.
string
Shipping zip code for the competitor’s address.
number
Number of employees at the competitor company. Must be non-negative.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_A_CONTACTTool to create a new contact in Fireberry CRM. Use when you need to add a new person to the system with contact information, billing address, and related account details.

Input Parameters

string
Fax
string
The GUID of the system user who created the record, can also be set manually. Will be used for permissions.
string
Job title
string
Last name
string
The related account’s GUID.
string
required
First name of the contact (Primary). This is a required field for creating a contact.
string
Department
integer
Gender of the contact (Picklist). Numeric code indicating gender.
integer
Salutation (Picklist). Numeric code indicating the salutation.
string
Primary phone number, contains exclusively numbers.
string
Secondary phone number, contains exclusively numbers.
string
Third used phone number, contains exclusively numbers.
string
Website of the contact in URL format.
string
Billing city
string
Company name
string
Description of up to 4,000 characters.
string
Manager name
string
Billing state
string
Primary mobile phone number.
string
Secondary mobile phone number.
string
Shipping city
string
Billing street
string
Primary email address, must be in email format.
string
Secondary email address, must be in email format.
string
Third used email address, must be in email format.
string
Shipping state
string
Billing country
string
Billing zip code
string
The date and time of the last action related to the contact, must be in UTC format.
string
Shipping street
string
Shipping country
string
Shipping zip code
string
The GUID of the most recent email related to the contact.
integer
Sets if the contact is valid for emails (Picklist). Numeric code indicating email validity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_ACTIVITY_LOGCreate a new Activity Log record in Fireberry. Use when you need to log activities such as phone calls, meetings, or other interactions with contacts and accounts.

Input Parameters

string
The GUID of the system user who created the record. Can be set manually and will be used for permissions.
string
The related record’s GUID. Can belong to any editable system object type. If set, objecttypecode must also be set.
integer
The type of call (Picklist value).
string
The related contact’s GUID.
integer
The result of the call (Picklist value).
string
Description of the activity log (up to 4,000 characters).
integer
Object number of the object the related record belongs to. REQUIRED if objectid is set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_A_DATE_FIELDTool to create a new date field in a Fireberry object/table. Use when you need to add custom date fields to CRM objects like accounts, contacts, or other entities for tracking dates such as contract dates, anniversaries, or custom date attributes.

Input Parameters

string
required
Field name used for system displays. This is the human-readable label shown in the UI.
boolean
To track all changes made to this field, set to true. Defaults to false.
string
required
System field name. Must start with ‘pcf’ or the field will not be created. Example: ‘pcftestdate’
integer
required
Use an object’s number here to assign this field to an object. Common examples: 1 for accounts, 2 for contacts, etc.
string
Value used by default for this field. Must match field requirements (date format).
string ("required" | "readonly")
Additional properties for the field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_A_LOOKUP_FIELDTool to create a lookup field in Fireberry CRM. Use when you need to add a lookup field that relates records from one object type to another.

Input Parameters

string
required
Field name used for system displays. This is the human-readable label shown in the UI.
boolean
To track all changes made to this field, set to true. Default is false.
string
Set a system field name to filter the results provided by the chosen field.
string
required
System field name. Must start with ‘pcf’ or the field will not be created. Default prefix is ‘pcf’.
integer
required
Use an object’s number here to assign this field to an object. This is the object type ID where the lookup field will be created.
string
Value used by default for this field. Must match field requirements, in this case a record’s ID from the correct object type.
The number of the object type this field will relate records from. This defines which object type records can be selected from the lookup.
string ("required" | "readonly")
Additional properties for the lookup field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_AN_ACCOUNTTool to create a new account in Fireberry CRM. Use when you need to add a new company or organization to the system with detailed information including contact details, billing address, and business metadata.

Input Parameters

string
Fax number.
string
Text of up to 4,000 characters explaining needs.
string
The GUID of the system user who created the record, can also be set manually. Will be used for permissions.
number
Account revenue.
string
ID of the person or company.
string
Last name.
string
First name.
integer
Sets the state of the account as active or inactive (Picklist). Use integer code.
string
A campaign’s GUID.
integer
Reason the account was lost (Picklist). Use integer code.
integer
Status of the account (Picklist). Use integer code for status.
string
Primary phone number, contains exclusively numbers.
string
Secondary phone number, contains exclusively numbers.
string
Third used phone number, contains exclusively numbers.
string
Website of the account in URL format.
string
required
Name of the account (Primary). This is the required primary field for creating an account.
string
Billing city.
string
Description of up to 4,000 characters.
string
Billing state.
string
Birthday date in UTC format (YYYY-MM-DD).
integer
Industry (Picklist). Use integer code for the industry category.
string
Used for identification, unique values are recommended.
string
Billing street address.
string
Primary email address, must be in email format.
string
Secondary email address, must be in email format.
string
Third used email address, must be in email format.
string
Text of up to 4,000 characters explaining objections against the product or service.
string
Billing country.
string
Billing zip code.
integer
Account type (Picklist). Use integer code for the type of account.
string
The parent account’s GUID.
integer
Secondary status code (Picklist). Use integer code for the secondary status.
integer
Type of ownership (Picklist). Use integer code for the business type.
integer
Payment terms (Picklist). Use integer code for payment terms.
string
The primary contact’s GUID.
integer
Account rating (Picklist). Use integer code for the rating level.
number
Number of employees.
integer
Shipping method (Picklist). Use integer code for shipping method.
integer
Automatically sets to ‘yes’ if the record is a duplicate, can be manually set (Picklist). Use integer code.
integer
Sets if the account will opt out of emails (Picklist). Use integer code.
integer
Lead source (Picklist). Use integer code for the lead origin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_AN_ARTICLETool to create a new article in Fireberry. Use when you need to add knowledge base articles, documentation, or help content to the system. The article requires a name (title) and subject (category). You can optionally provide the article body, description, owner, state, status, and view count.

Input Parameters

string
The GUID of the system user who created the record, can also be set manually. Will be used for permissions.
integer
The state of the article (Picklist). Numeric ID representing the state.
integer
Editable number of times the article was viewed.
integer
The status of the article (Picklist). Numeric ID representing the status.
string
Long text body of the article. The main content of the article.
string
required
Article name (Primary field, required). The title or name of the article.
string
Description of up to 4,000 characters. A brief summary or description of the article.
integer
required
Set the topic of the article (Picklist, required). Numeric ID representing the subject/category of the article.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_AN_ASSETCreates a new asset (account product) in Fireberry. Use this to associate products or services with customer accounts, tracking details like quantity, price, installation dates, and status.

Input Parameters

number
Price of the asset. Must be non-negative.
string
The GUID of the system user who created the record. Can be set manually and will be used for permissions.
number
Quantity of the selected product. Must be non-negative.
string
required
The related account’s GUID. This is the account/company to which the asset will be associated.
string
required
The related product’s GUID. This identifies which product/service is being added as an asset.
string
UTC formatted date and time of expiration. Format: YYYY-MM-DD or ISO 8601 datetime.
integer
Status of the asset (Picklist). Use the appropriate integer status code from your Fireberry configuration.
string
Description of the asset. Maximum length is 4,000 characters.
string
UTC formatted date and time of installation. Format: YYYY-MM-DD or ISO 8601 datetime.
string
Date and time of the purchase in UTC format. Format: YYYY-MM-DD or ISO 8601 datetime.
string
Used for identification of the asset. Unique values are recommended.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_AN_OPPORTUNITYTool to create a new opportunity in Fireberry CRM. Use when you need to add a new sales opportunity to track potential deals with estimated values, close dates, and associated accounts.

Input Parameters

string
required
Name of the opportunity (Primary field, required). This is the main identifier for the opportunity.
string
The GUID of the system user who created the record. Can also be set manually. Will be used for permissions.
string
The related account’s GUID. Links this opportunity to a specific account/company.
integer
Sales stage of the opportunity. This is a picklist field - use integer code value.
string
The related contact’s GUID. Links this opportunity to a specific contact person.
integer
Status of the opportunity. This is a picklist field - use integer code value.
string
Description of up to 4,000 characters providing details about the opportunity.
string
Estimated monetary value of the opportunity. Provide as a string representation of the numeric value.
string
Expected close date for the opportunity in UTC format (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_AN_ORDER_ITEMTool to create a new order item in Fireberry CRM. Use when you need to add line items or products to an existing order with details like quantity, price, and description.

Input Parameters

integer
Use 2 to include VAT in the set itemprice, or use 1 to have it added on to the total price. (Picklist)
string
A system user’s GUID, will fill in automatically with the user who created the item and be used for permissions. Can be set manually to assign ownership.
integer
Set the order the items will be listed in, will appear in ascending order starting with the lowest at the top. Use integer values to control display sequence.
number
Set the price of the product as a decimal number. This is the unit price before quantity calculation.
string
Use a product’s globally unique identifier (GUID) to relate it to this order item from the product catalog.
string
required
Use an Order’s globally unique identifier (GUID) to set which order this item will appear in and be related to. This is required to associate the item with an existing order.
string
Free text description of the order item or product to provide additional details.
string
required
Set the name of a related or custom product. This is the required primary field for the order item.
number
Set the quantity of the product. Can be a decimal for fractional quantities (e.g., 2.5 units).
string
Set the catalog number of the product for inventory tracking and identification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_A_NOTECreate a new note record in Fireberry. Use when you need to add notes to records such as accounts, contacts, or other objects. Supports HTML formatting and reply threads.

Input Parameters

string
required
Content of the note, to format use HTML (Primary). This is the required primary field for creating a note.
string
The GUID of the record related to the note. If you set this field, you MUST also set objecttypecode.
string
Use a note’s GUID to set this note as a reply to it. Make sure the objectid, objecttitle, and objecttypecode fields are identical in both notes.
integer
Object number of the object the related record belongs to. REQUIRED if objectid is set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_A_PHONE_CALLCreates a new phone call record in Fireberry’s call log. Use this to log incoming, outgoing, or internal phone calls with details like duration, status, and participants.

Input Parameters

string ("incoming" | "outgoing" | "internal")
Type of the phone call.
string ("answered" | "busy" | "missed" | "cancelled" | "disconnected_number" | "left_message")
Status of the phone call.
string
The GUID of the system user who created the record. Can be set manually and will be used for permissions.
string
The phone number the call originated from (Primary). Format depends on your system configuration.
number
The amount of time the phone rings until the line is connected or disconnected. Displays in seconds. Must be non-negative.
number
The duration of the call in seconds, does not include the dial time. Must be non-negative.
string
The phone number receiving the call. Format depends on your system configuration.
string
The related account’s GUID. Use this to associate the call with a specific account/company in Fireberry.
string
The extension of the phone number the call originated from.
number
Price of the call. Must be non-negative.
string
The related contact’s GUID. Use this to associate the call with a specific contact person in Fireberry.
string
Queue name associated with the call.
string
A link to a recording of the call. Must be in valid URL format.
string
The extension of the receiving phone number.
string
Voice Mail box name if the call went to voicemail.
string
required
The unique ID of the phone call. This is required and must be unique for each call record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_A_PRODUCTTool to create a new product in Fireberry. Use when you need to add a new product to the system with details like catalog number, name, vendor information, and status.

Input Parameters

string
Name of the product. This is the display name that identifies the product.
string
Product owner GUID. The GUID of the system user who owns this product record.
number
Unit price of the product. The selling price per unit.
integer
Status code of the product. Numeric code representing the current status or state of the product.
string
Vendor name. Name of the vendor or supplier for this product.
number
Unit cost of the product. The cost price per unit for inventory management.
string
Description of the product. Detailed information about the product features and specifications.
integer
Category code. Numeric code representing the product category for classification.
number
Quantity of the product. Available stock quantity or initial inventory amount.
string
Product code. Catalog number used for product identification and inventory tracking.
string
Vendor part number. The vendor’s part number used to reference the product in the vendor’s system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_A_PROJECTTool to create a new project in Fireberry CRM. Use when you need to add a new project to track work, budgets, timelines, and deliverables.

Input Parameters

number
Budget allocated for the project.
string
Date the project must be completed by, use UTC format (YYYY-MM-DD).
string
The GUID of the system user who created the record, can also be set manually. Will be used for permissions.
integer
Priority (Picklist). Use integer code to set the priority level of the project (e.g., low, medium, high, critical).
string
The related account’s GUID. Links this project to a specific account in the system.
integer
Status (Picklist). Use integer code to set the current status of the project (e.g., planning, in progress, completed).
string
required
Name of the project (Primary field, required). This is the main identifier for the project.
string
The related order’s GUID. Links this project to a specific order.
number
Estimated work time needed to complete the project (in hours).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_A_TASKTool to create a new task in Fireberry CRM. Use when you need to create to-do items, action items, or work assignments with tracking information.

Input Parameters

string
The GUID of the system user who created the record. Can be set manually. Will be used for permissions.
string
required
Task subject/title (Primary field, required). This is the main identifier for the task.
string
The GUID of the record this task is related to. If set, objecttypecode must also be provided.
string
Status (Picklist). String value to set the current status of the task.
string
Description of up to 4,000 characters. Provide detailed information about the task.
string
The GUID of the system user the task is assigned to. Determines who is responsible for completing this task.
string
Priority (Picklist). String value to set the urgency level of the task.
string
Task type (Picklist). String value to categorize the type of task.
string
Object number of the object the related record belongs to. Required if objectid is set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_A_TICKETTool to create a new ticket (case) in Fireberry CRM. Use when you need to log customer issues, support requests, or service cases with detailed tracking information.

Input Parameters

string
required
Ticket title (Primary field, required). This is the main identifier for the ticket.
string
The GUID of the system user who created the record, can also be set manually. Will be used for permissions.
string
The related account’s GUID. Links this ticket to a specific account in the system.
string
The related contact’s GUID. Links this ticket to a specific contact person.
integer
Ticket state, such as open or closed (Picklist). Use integer code to set the current state of the ticket.
integer
Status (Picklist). Use integer code to set the detailed status of the ticket (e.g., new, in progress, on hold, resolved).
string
Description of up to 4,000 characters. Provide detailed information about the ticket issue or request.
string
The GUID of the system user the task is assigned to. Determines who is responsible for handling this ticket.
integer
Ticket type (Picklist). Use integer code to categorize the type of ticket (e.g., question, problem, request).
integer
Priority (Picklist). Use integer code to set the urgency level of the ticket (e.g., low, medium, high, critical).
integer
Ticket source (Picklist). Use integer code to specify where the ticket originated (e.g., phone, email, web).
string
The related asset’s GUID. Links this ticket to a specific asset or product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_A_URL_FIELDTool to create a new URL field in a Fireberry object/table. Use when you need to add custom URL fields to CRM objects like accounts, contacts, or other entities for storing website links, company URLs, or other web addresses.

Input Parameters

string
required
Field name used for system displays. This is the human-readable label shown in the UI.
boolean
To track all changes made to this field, set to true. Defaults to false.
string
required
System field name. Must start with ‘pcf’ or the field will not be created. Example: ‘pcftesturl’
integer
Number between 1-200 to limit length of text.
integer
required
Use an object’s number here to assign this field to an object. Common examples: 1 for accounts, 2 for contacts, etc.
boolean
To autocomplete values for this field, set to true. Defaults to false.
string
Value used by default for this field. Must match field requirements (valid URL format).
string ("required" | "readonly")
Additional properties for the field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_CAMPAIGNTool to create a new campaign in Fireberry. Use when you need to add a new marketing or sales campaign to track campaign activities, budgets, and outcomes.

Input Parameters

number
Cost incurred by the campaign.
string
Date the campaign ends, use UTC format (YYYY-MM-DD).
string
The GUID of the system user who created the record. Can also be set manually. Will be used for permissions.
integer
Type of campaign. This is a picklist field - use integer code value.
string
Date the campaign starts, use UTC format (YYYY-MM-DD).
number
Budget allocated for the campaign.
integer
Type of media used. This is a picklist field - use integer code value.
integer
Status of the campaign. This is a picklist field - use integer code value.
string
Description of up to 4,000 characters providing details about the campaign.
string
required
Name of the campaign (Primary field, required). This is the main identifier for the campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_CRM_ORDERTool to create a new CRM Order in Fireberry. Use when you need to create an order with line items linked to an account.

Input Parameters

string
The fax number associated with the related account.
object
required
Order items to add to your order. At least one item is required.
string
Full address of the related account.
string
A system user’s GUID, will fill in automatically with the user who created the order and be used for permissions. Can be set manually.
string
The ID number associated with the related account.
string
required
Use an Account’s globally unique identifier (GUID) to relate it to this order. This is required to link the order to a customer account.
string
The phone number associated with the related account.
integer
Status of the order (Picklist)
string
required
Company name of the related account. This is required for order creation.
string
Free text description of the order.
integer
Set the number which represents the relevant currency. (Picklist)
string
The email address associated with the related account.
number
Set a number discount for the whole order. If the amountdiscountpercent field is also set, the discount set here will not be applied.
integer
To include VAT in the total enter 1, otherwise enter 0. Defaults to include VAT unless defined otherwise. (Picklist)
integer
To apply a round discount to the order enter 1, otherwise enter 2. Defaults to no discount. (Picklist)
number
Set a percentage discount for the whole order. This will take precedence over the amountdiscount field if both are set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_FILETool to upload a file to a specific record in Fireberry. Use when you need to attach documents, images, or other files to existing records such as accounts, contacts, or custom objects.

Input Parameters

object
required
File to upload to the Fireberry record.
string
required
The number of the object the record belongs to. This is the numeric ID of the Fireberry object type (e.g., ‘1’ for accounts). Use this to specify which object type the record belongs to.
string
required
The GUID of the record you’d like to add a file to. This is the unique identifier of the specific record within the object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_MEETINGTool to create a new meeting (activity) in Fireberry. Use when you need to schedule a meeting in the CRM system. The created meeting will be returned with its system-generated ID and all default values populated.

Input Parameters

string
The GUID of the system user who created the record. Can be set manually. Will be used for permissions.
string
required
The subject of the meeting (Primary). This is a required field.
string
Location where the meeting will take place.
string
The GUID of the record related to the meeting. If set, objecttypecode must also be provided.
string
The GUID of the resource used for the meeting.
integer
Status of the meeting (Picklist). Numeric code indicating meeting status.
string
Description of the meeting, up to 4,000 characters.
integer
Priority of the meeting (Picklist). Numeric code indicating priority level.
string
Date and time the meeting ends. Must be in valid date format.
integer
Object number of the object the related record belongs to. Required if objectid is set.
string
Date and time the meeting starts. Must be in valid date format.
integer
The type of activity (Picklist). Numeric code identifying the activity type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_CREATE_RECORDCreates a new record in a specified Fireberry table/module. Use this tool when you need to add new records to Fireberry (e.g., create a new account, contact, or deal). The created record will be returned with its system-generated ID and all default values populated. Common use cases: - Create new accounts/companies in the CRM - Add new contacts to the system - Insert leads, opportunities, or custom records Note: Field names are case-sensitive and must match Fireberry’s system field names.

Input Parameters

object
required
Dictionary of field names and values for the new record. Field names must match Fireberry’s system field names (e.g., ‘accountname’, ‘emailaddress1’, ‘telephone2’). Required fields depend on the table schema - typically the primary field (like ‘accountname’ for Account table) is required. Optional fields can be omitted.
string
required
Name or numeric ID of the Fireberry object/table where the record will be created. Common examples: ‘Account’ (for accounts), ‘Contact’ (for contacts), or numeric IDs like ‘1’, ‘2’. The name is case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_ACCOUNTTool to delete an account from Fireberry using its GUID. Use when you need to permanently remove an account record from the system.

Input Parameters

string
required
The account’s GUID. This is the unique identifier for the account to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_A_COMPETITORTool to delete a competitor in Fireberry by its GUID. Use when you need to permanently remove a competitor record from the system.

Input Parameters

string
required
Competitor’s GUID (globally unique identifier) to delete. This is the unique identifier for the competitor record in Fireberry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_A_CONTRACTTool to delete a contract in Fireberry by its GUID. Use when you need to permanently remove a contract record from the system.

Input Parameters

string
required
Use a Contract’s GUID (globally unique identifier) to delete. This is the unique identifier for the contract record in Fireberry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_ACTIVITY_LOGDelete an activity log by its GUID. Use when you need to remove a specific activity log record from Fireberry. The activity log ID must be a valid GUID obtained from querying activity logs.

Input Parameters

string
required
The GUID of the activity log to delete. Must be a valid UUID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_A_CUSTOM_FIELDTool to delete a custom field from a Fireberry object/table. Use when you need to permanently remove a custom field from CRM objects like accounts, contacts, or other entities.

Input Parameters

string
required
The system name of the field to delete. Must be the exact system name as stored in Fireberry.
string
required
The field type of the field to delete. Examples: ‘number’, ‘text’, ‘date’, ‘lookup’, etc.
integer
required
The number of the object the desired field can be found in. Common examples: 1 for accounts, 2 for contacts, etc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_AN_ARTICLETool to delete an article from Fireberry by its GUID. Use when you need to permanently remove an article record from the system.

Input Parameters

string
required
The GUID of the article to delete. Must be a valid article GUID (e.g., ‘cceaf3fb-b2ec-4626-b738-e8720fc0d667’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_AN_ASSETDelete an asset from Fireberry by its unique identifier. Use this tool when you need to remove an asset record from the Fireberry system. The asset is permanently deleted and cannot be recovered once this operation completes successfully.

Input Parameters

string
required
The unique identifier (GUID) of the asset to delete. This is the accountproduct record ID in Fireberry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_AN_OPPORTUNITYTool to delete an opportunity in Fireberry by its GUID. Use when you need to permanently remove an opportunity record from the system.

Input Parameters

string
required
Opportunity’s GUID (globally unique identifier) to delete. This is the unique identifier for the opportunity record in Fireberry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_AN_ORDER_ITEMTool to delete an order item in Fireberry by its GUID. Use when you need to permanently remove an order item (line item/product) from an order.

Input Parameters

string
required
Use an Order Item’s GUID (globally unique identifier) to delete the order item. This is the unique identifier for the order item record in Fireberry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_A_NOTETool to delete a note from Fireberry using its GUID. Use when you need to remove a specific note record from the system.

Input Parameters

string
required
Use a note’s GUID. This is the unique identifier of the note record to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_A_PHONE_CALLTool to delete a phone call record from Fireberry using its GUID. Use when you need to remove a specific phone call entry from the system.

Input Parameters

string
required
Use a phone call’s GUID. This is the unique identifier of the phone call record to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_A_PROJECTTool to delete a project from Fireberry using its GUID. Use when you need to permanently remove a project record from the system.

Input Parameters

string
required
Use a project’s GUID. This is the unique identifier of the project record to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_A_TASKTool to delete a task in Fireberry by its GUID. Use when you need to permanently remove a task record from the system.

Input Parameters

string
required
Task’s GUID (globally unique identifier) to delete. This is the unique identifier for the task record in Fireberry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_A_TICKETTool to delete a ticket (case) from Fireberry using its GUID. Use when you need to permanently remove a ticket record from the system.

Input Parameters

string
required
Use a ticket’s GUID. This is the unique identifier of the ticket (case) record to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_BUSINESS_UNITTool to delete a Business Unit in Fireberry using its GUID. Use when you need to remove a Business Unit from the system permanently. Note: This is a destructive operation that cannot be undone.

Input Parameters

string
required
The Business Unit’s GUID (unique identifier) to delete. This is the system-generated identifier for the Business Unit record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_CAMPAIGNTool to delete a campaign from Fireberry. Use when you need to permanently remove a campaign record from the system. The deletion is permanent and cannot be undone.

Input Parameters

string
required
Campaign GUID to delete. Must be a valid campaign identifier (e.g., ‘7be626e4-711c-4378-8845-e8ed9482ece6’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_CONTACTTool to delete a contact from Fireberry using its GUID. Use when you need to permanently remove a contact record from the system.

Input Parameters

string
required
Use a Contact’s GUID. This is the unique identifier for the contact to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_CRM_USERTool to delete a CRM user from Fireberry using its GUID. Use when you need to permanently remove a CRM user record from the system.

Input Parameters

string
required
Use a CRM user’s GUID. This is the unique identifier for the CRM user to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_MEETINGTool to delete a meeting activity from Fireberry by its GUID. Use when you need to remove an existing meeting record from the system.

Input Parameters

string
required
Must be a globally unique identifier (GUID) in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx of the meeting activity to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_DELETE_PRODUCTTool to delete a product in Fireberry by its GUID. Use when you need to permanently remove a product record from the system.

Input Parameters

string
required
Product’s GUID (globally unique identifier) to delete. This is the unique identifier for the product record in Fireberry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ACCOUNTTool to retrieve a specific account record by its GUID. Use when you need to fetch detailed information about an existing account in Fireberry.

Input Parameters

string
required
The GUID (unique identifier) of the account to retrieve. Must be a valid Fireberry account GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_A_CRMORDERTool to retrieve a specific CRM Order from Fireberry by its GUID. Use when you need to get detailed information about a particular order.

Input Parameters

string
required
The GUID (unique identifier) of the CRM Order to retrieve. Must be a valid Fireberry CRM Order GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_ACCOUNTS3Retrieve a page of Fireberry CRM account records, with account details and pagination metadata. Page number and page size inputs are available; Fireberry documents a maximum of 50 records per page and page number 10.

Input Parameters

integer
Number of records per page (default: 50)
integer
Page number for pagination (default: 1)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_ACTIVITY_LOGS2Retrieve Fireberry activity logs with pagination support. Use to list activity log records and their pagination metadata.

Input Parameters

integer
The maximum number of records displayed per page, cannot exceed 50.
integer
The number of the page displayed, cannot exceed 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_ARTICLESTool to retrieve all articles from Fireberry with pagination support. Use when you need to list or search through knowledge base articles. Returns articles with metadata including articlename, articlesubject, articlebody, and other fields.

Input Parameters

string
The maximum number of records displayed per page, cannot exceed 50.
string
The number of the page displayed, cannot exceed 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_ASSETS2Tool to retrieve all assets (account products) from Fireberry with pagination support. Use when you need to list assets associated with accounts.

Input Parameters

integer
Maximum records per page (default: 50, cannot exceed 50)
integer
Page number to display (default: 1, cannot exceed 10)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_BUSINESS_UNITS2Retrieve business units from Fireberry with pagination support. Use to list or browse business units in the organization.

Input Parameters

integer
The maximum number of records displayed per page, cannot exceed 50.
integer
The number of the page displayed, cannot exceed 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_CAMPAIGNSTool to retrieve all campaigns from Fireberry with pagination support. Use when you need to list campaigns, view campaign details, or iterate through campaign records in the CRM.

Input Parameters

string
The maximum number of records displayed per page, cannot exceed 50
string
The number of the page displayed, cannot exceed 10

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_COMPETITORS2Tool to retrieve all competitors from Fireberry with pagination support. Use when you need to list or browse competitors in the CRM with detailed field information.

Input Parameters

integer
Maximum records per page (default: 50, max: 50)
integer
Page number to display (default: 1, max: 10)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_CONTACTSTool to retrieve all contacts from Fireberry with pagination support. Use when you need to list or browse contacts in the CRM.

Input Parameters

string
The maximum number of records displayed per page, cannot exceed 50.
string
The number of the page displayed, cannot exceed 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_CONTRACTS2Tool to retrieve all contracts from Fireberry with pagination support. Use when you need to list or browse contracts in the CRM.

Input Parameters

string
The maximum number of records displayed per page, cannot exceed 50.
string
The number of the page displayed, cannot exceed 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_CUSTOM_OBJECT_RECORDSTool to retrieve all records from a specified custom object in Fireberry with pagination support. Use when you need to list or browse records from custom objects or standard objects (Accounts, Cases, Tasks) in the CRM.

Input Parameters

string
The maximum number of records displayed per page, cannot exceed 50.
string
required
Object code or system name. Standard objects: 1=Account, 5=Cases, 10=Task. Custom objects use codes >= 1000. Either system name or object number can be used.
string
The number of the page displayed, cannot exceed 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_MEETINGS3Retrieve Fireberry activity records with pagination support, including meeting records. The request does not filter activities by type.

Input Parameters

integer
The maximum number of records displayed per page, cannot exceed 50
integer
The number of the page displayed, cannot exceed 10

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_NOTES2Retrieve notes from Fireberry with pagination support and a detailed set of note fields. The response includes only fields declared in the note schema.

Input Parameters

string
The maximum number of records displayed per page, cannot exceed 50
string
The number of the page displayed, cannot exceed 10

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_OBJECTSTool to retrieve all object type metadata from Fireberry. Use when you need to discover available object types in the system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_OPPORTUNITIESDEPRECATED: Use FIREBERRY_LIST_ALL_OPPORTUNITIES2 instead. Tool to retrieve all opportunities from Fireberry with pagination support. Use when you need to list or browse opportunities in the CRM.

Input Parameters

string
The maximum number of records displayed per page, cannot exceed 50.
string
The number of the page displayed, cannot exceed 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_ORDER_ITEMSTool to retrieve all order items from Fireberry with pagination support. Use when you need to list or browse order items in the CRM.

Input Parameters

string
The maximum number of records displayed per page, cannot exceed 50.
string
The number of the page displayed, cannot exceed 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_ORDERSTool to retrieve all orders from Fireberry with pagination support. Use when you need to list or browse orders in the CRM.

Input Parameters

string
The maximum number of records displayed per page, cannot exceed 50.
string
The number of the page displayed, cannot exceed 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_PHONE_CALLSTool to retrieve all phone call records from Fireberry with pagination support. Use when you need to fetch call logs, analyze call history, or retrieve phone call details from the CRM.

Input Parameters

string
The maximum number of phone call records displayed per page. Cannot exceed 50. Use smaller values for faster responses.
string
The page number to retrieve (1-indexed). Cannot exceed 10. Use for pagination when retrieving large result sets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_PROJECTS2Tool to retrieve all projects from Fireberry with pagination support. Use when you need to list or browse projects in the CRM with detailed field information.

Input Parameters

integer
Maximum records per page (default: 50, max: 50)
integer
Page number to display (default: 1, max: 10)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_TASKSTool to retrieve all tasks from Fireberry with pagination support. Use when you need to list or browse tasks in the CRM.

Input Parameters

string
The maximum number of records displayed per page, cannot exceed 50.
string
The number of the page displayed, cannot exceed 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_TICKETS2Tool to retrieve all ticket records (cases) from Fireberry with pagination support. Use when you need to list tickets, browse support cases, or retrieve ticket details from the CRM.

Input Parameters

integer
The maximum number of records displayed per page, cannot exceed 50.
integer
The number of the page displayed, cannot exceed 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ALL_USERSTool to retrieve all CRM users from Fireberry with pagination support. Use when you need to list or browse users in the CRM system.

Input Parameters

string
The maximum number of records displayed per page, cannot exceed 50.
string
The number of the page displayed, cannot exceed 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_A_MEETINGTool to retrieve a specific meeting/activity record by its unique identifier (GUID). Use when you need to fetch details about a particular meeting, call, or activity including its subject, description, related contacts, and status.

Input Parameters

string
required
The GUID (unique identifier) of the meeting/activity record to retrieve. Must be a valid GUID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_AN_ACTIVITY_LOGTool to retrieve a specific activity log record from Fireberry by its GUID. Use when you need to fetch detailed information about a particular activity log entry.

Input Parameters

string
required
Use an activity log’s GUID to retrieve its details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_AN_ARTICLETool to retrieve a specific article from Fireberry by its GUID. Use when you need to fetch detailed information about a particular article including its name, subject, body content, description, owner, state, status, and view count.

Input Parameters

string
required
The GUID (unique identifier) of the article to retrieve. Must be a valid article GUID in UUID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_AN_ASSETTool to retrieve a specific asset record by its GUID. Use when you need to get detailed information about an asset.

Input Parameters

string
required
The unique GUID of the asset to retrieve (e.g., ‘7789faff-ac20-4a28-8df3-2d12f15573c6’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_AN_OBJECTTool to retrieve metadata for a specific object by its ID. Use when you need to get information about an object’s name, type, and system name.

Input Parameters

integer
required
The unique identifier (number) of the object to retrieve metadata for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_AN_OBJECTS_FIELDSTool to retrieve metadata about fields for a specific object type in Fireberry. Use when you need to discover available fields, field types, and field labels for an object.

Input Parameters

integer
required
Use an object’s number. Numeric identifier of the object type (e.g., 1 for Account, 2 for Contact).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_AN_OPPORTUNITYTool to retrieve a specific opportunity record by its GUID. Use when you need to fetch detailed information about an existing sales opportunity in Fireberry.

Input Parameters

string
required
The GUID (unique identifier) of the opportunity to retrieve. Must be a valid Fireberry opportunity GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_AN_ORDER_ITEMTool to retrieve a specific order item record by its GUID. Use when you need to get detailed information about an order item.

Input Parameters

string
required
The unique GUID of the order item to retrieve (e.g., ‘a17f964a-df7e-4234-ade8-cbdd0450830c’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_A_NOTETool to retrieve a specific note record by its GUID. Use when you need to fetch detailed information about a note including its content, related object, parent note, and timestamps.

Input Parameters

string
required
Use a note’s GUID. The unique identifier of the note to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_A_PHONE_CALLTool to retrieve a specific phone call record from Fireberry by its GUID. Use when you need to fetch detailed information about a particular call from the call log.

Input Parameters

string
required
The GUID of the phone call record to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_A_PRODUCTTool to retrieve a specific product record by its GUID. Use when you need to get detailed information about a product.

Input Parameters

string
required
The unique GUID of the product to retrieve (e.g., ‘cb96d1ee-8423-48e1-84f8-0c7fead90bc2’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_A_PROJECTTool to retrieve a specific project from Fireberry by its GUID. Use when you need to get detailed information about a particular project.

Input Parameters

string
required
The GUID of the project to retrieve. Must be a valid project identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_A_TASKTool to retrieve a specific task record by its GUID. Use when you need to get detailed information about an existing task in Fireberry.

Input Parameters

string
required
The GUID (unique identifier) of the task record to retrieve. Must be a valid Fireberry task GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_A_TICKETTool to retrieve a specific ticket (case) record by its GUID. Use when you need to get detailed information about an existing support ticket or case in Fireberry.

Input Parameters

string
required
Use a ticket’s GUID. This is the unique identifier for the ticket/case record to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_CAMPAIGNTool to retrieve a single campaign by its GUID. Use when you need to fetch detailed information about a specific campaign.

Input Parameters

string
required
The campaign’s GUID identifier (e.g., ‘80490725-ca52-4eba-b2b2-04e1f845770d’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_COMPETITORTool to retrieve a specific competitor record by its GUID. Use when you need to fetch detailed information about an existing competitor in Fireberry.

Input Parameters

string
required
Use a Competitor’s GUID. Must be a valid Fireberry competitor GUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_CONTACTTool to retrieve a specific contact record by its GUID. Use when you need to fetch detailed information about an existing contact in Fireberry.

Input Parameters

string
required
Use a Contact’s GUID (unique identifier) to retrieve the contact record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_CUSTOM_OBJECT_RECORDTool to retrieve a specific custom object record by its GUID and object code. Use when you need to fetch detailed information about an existing custom object record in Fireberry.

Input Parameters

string
required
The GUID (globally unique identifier) of the specific custom object record to retrieve.
string
required
The code identifier for the custom object type (e.g., ‘account’, ‘contact’, or custom object codes like ‘1000’). Standard objects: 1=Account, 5=Cases, 10=Task. Custom objects use codes >= 1000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_FIELD_DETAILSTool to retrieve detailed metadata for a specific field in a Fireberry object/table. Use when you need to understand field properties, types, or labels for a given field in an object.

Input Parameters

string
required
Numeric ID of the record type/object the field belongs to (e.g., ‘1’ for Account, ‘2’ for Contact). Use the object number that the field is part of.
string
required
System field name of the field to retrieve details for (e.g., ‘emailaddress1’, ‘accountname’, ‘statuscode’). This is the internal field identifier used by Fireberry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_OBJECT_FIELD_VALUESTool to retrieve picklist field values from the metadata endpoint. Use when you need to get all available options for a picklist field including their IDs, labels, and active status.

Input Parameters

integer
required
Use the object number of the object the field used above belongs to (e.g., 1 for Account, 2 for Contact).
string
required
Use the picklist field’s system field name (e.g., accounttypecode, industrycode).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_ORDERS_ITEMSTool to retrieve all items for a specific order from Fireberry. Use when you need to get the line items, products, quantities, and pricing details associated with a particular order.

Input Parameters

string
required
The unique GUID of the order to retrieve items for (e.g., ‘39fca23f-e247-46a8-a0f3-3820de12c7bf’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_PICKLIST_FIELD_VALUESTool to retrieve picklist field values from Fireberry metadata API. Use when you need to get all available options for a specific picklist field on an object type.

Input Parameters

integer
required
The object number of the object the field belongs to (e.g., 2 for Contact, 1 for Account). This is a numeric ID that identifies the object type in Fireberry.
string
required
The system field name for the picklist field (e.g., ‘salutation’, ‘industrycode’). This is the internal field name in Fireberry, not the display label.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_PICKLIST_VALUESRetrieve distinct picklist values observed in up to 100 queried records for a specific field in a Fireberry record type. Returned active flags are set to true and do not indicate verified option status.

Input Parameters

string
required
System field name of the picklist field (e.g., industrycode, statuscode)
string
required
Numeric ID of the record type/object (e.g., 1 for Account, 2 for Contact)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_TASKTool to retrieve a single task record by its unique ID (GUID). Use when you need to fetch complete details of a specific task from Fireberry.

Input Parameters

string
required
The task’s GUID (unique identifier for the task record). Must be a valid UUID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_GET_USERTool to retrieve a single user by their unique ID from Fireberry. Use when you need to fetch details about a specific user including their name, email, role, and status.

Input Parameters

string
required
User’s GUID (36 character string with 32 hexadecimal characters and 4 hyphens, e.g., ‘a274c6fe-66bd-42d2-be4d-2356de14b3a5’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_LIST_ALL_OPPORTUNITIES2Tool to retrieve all opportunities from Fireberry CRM with pagination support. Use when you need to list or search through opportunity records in the system.

Input Parameters

integer
Number of records per page (default: 50)
integer
Page number for pagination (default: 1)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_LIST_ALL_PRODUCTS2Tool to retrieve all products from Fireberry CRM with pagination support. Use when you need to list, browse, or search through product records in the system.

Input Parameters

integer
Maximum records per page, max 50
integer
Page number, max 10

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_QUERY_RECORDSQuery Fireberry module records with one optional filter condition, sorting, and pagination. Results include record data and a calculated total that estimates the count when more pages remain.

Input Parameters

integer
Page number for pagination (must be >= 1)
array
Optional list of sorting rules to order the results. Multiple sort fields will be applied in the order specified.
array
Optional list of specific field names to return in the results. Note: The API may return all fields regardless of this parameter. Field names should match the Fireberry field system names (e.g., ‘accountname’, ‘emailaddress1’).
object
Defines a single filter condition for querying records.
string
required
The module identifier to query records from. Common values: ‘1’ for Accounts, ‘2’ for Contacts. Can be numeric string or module system name. Must be a numeric string; named strings like ‘contacts’ cause an invalid objecttype error.
integer
Number of records per page (must be >= 1)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_QUERY_RECORDS2Query records in any Fireberry object with advanced filtering, sorting, and pagination. Use the query field to specify filter conditions that records must meet to be returned. This action provides direct access to Fireberry’s query API endpoint with support for complex filter expressions, field selection, and result ordering. Ideal for searching specific records, building reports, or retrieving filtered datasets.

Input Parameters

string
Query filter string to narrow down results. Use format: (fieldname operator value) with AND/OR operators for multiple conditions. Operators: = (equals), > (greater than), < (less than), >= (greater or equal), <= (less or equal), contains, startsWith, endsWith. Example: ‘(idnumber = 12345678)’ or ‘(accountname contains Sample) AND (statuscode = 1)’.
string
Comma-separated list of field names to return in the results. If not specified, all fields are returned. Use Fireberry system field names (e.g., ‘accountname,emailaddress1,telephone1’).
string
required
The object type to query. Use the object’s system name (e.g., ‘account’, ‘contact’, ‘lead’) or numeric ID. Common values: ‘account’ or ‘1’ for Accounts, ‘contact’ or ‘2’ for Contacts, ‘cases’ or ‘5’ for Cases.
string
Field name to sort results by. Use Fireberry system field names (e.g., ‘accountname’, ‘createdon’).
integer
Number of records to return per page. Default is 50.
string
Sort direction: ‘asc’ for ascending (A-Z, oldest first) or ‘desc’ for descending (Z-A, newest first).
integer
The object type identifier as an integer (e.g., 1 for Account, 2 for Contact, 5 for Cases). If not provided, the system will attempt to resolve from the ‘object’ parameter.
integer
Page number for pagination (1-indexed). Default is 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_A_BUSINESS_UNITTool to update an existing business unit in Fireberry. Use when you need to modify business unit details such as name, manager, address, or organizational hierarchy. Only the fields you provide will be updated; other fields remain unchanged.

Input Parameters

string
required
The GUID of the business unit to update (e.g., ‘a0cd3305-77d4-4285-afbe-c0a30e9d150d’)
string
Fax number for the business unit
string
Name of the business unit (Primary field)
string
The GUID of the system user who created the record, can also be set manually. Will be used for permissions
string
The GUID of the system user set as the manager of this business unit
string
Phone number for the business unit
string
City for the business unit’s address
string
Name of the division this business unit belongs to
string
Street name for the business unit’s address
string
Country for the business unit’s address
string
Name or ID of the organization this business unit belongs to
string
Zip code for the business unit’s address
string
Street number for the business unit’s address
string
The GUID of the parent business unit if this is a child unit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_ACCOUNTUpdates an existing account record in Fireberry with new field values. Use this tool when you need to modify account information such as name, contact details, revenue, or other attributes. The account is identified by its GUID, and only the fields provided in the request will be updated.

Input Parameters

string
required
The GUID of the account to update (e.g., ‘14863f32-a85f-4b8d-aebf-6a80f1ad3b3c’). This is the unique identifier for the account record.
number
Annual revenue figure for the account. Can be used for reporting and segmentation.
string
Primary phone number for the account. Should contain numeric digits only.
string
required
Name of the account (Primary field, required). This is the main identifier for the account.
string
Detailed description or notes about the account. Maximum length is 4,000 characters.
string
Account identification number or code. Used for custom tracking or integration with external systems.
string
Primary email address for the account. Must be a valid email format (e.g., user@example.com).
integer
Picklist value (integer code) representing the account type. Use GetPicklistValues action to retrieve valid codes for this field.
integer
Picklist value (integer code) representing the account rating. Use GetPicklistValues action to retrieve valid codes for this field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_A_COMPETITORUpdate a Fireberry competitor record by GUID, supplying its name and optionally changing details such as description, website, SWOT analysis, address, revenue, employee count, or product information.

Input Parameters

string
Opportunities from the SWOT (Strengths, Weaknesses, Opportunities, Threats) model analysis.
string
Strengths from the SWOT (Strengths, Weaknesses, Opportunities, Threats) model analysis.
string
Threats from the SWOT (Strengths, Weaknesses, Opportunities, Threats) model analysis.
string
Weaknesses from the SWOT (Strengths, Weaknesses, Opportunities, Threats) model analysis.
string
required
Use a competitor’s GUID (unique identifier) to specify which competitor record to update.
string
The GUID of the system user who created the record, can also be set manually. Will be used for permissions.
number
Revenue of the competition, precision set to .00 (two decimal places).
string
Name of the competitive product offered by this competitor.
string
Website of the competitor in URL format.
string
Description of up to 4,000 characters providing details about the competitor.
string
Shipping city for the competitor’s location.
string
Shipping state for the competitor’s location.
string
required
Name (Primary) of the competitor. This is a required field.
string
Shipping street address for the competitor’s location.
string
Shipping country for the competitor’s location.
string
Shipping zip code for the competitor’s location.
number
Number of employees working at the competitor organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_A_CONTACTTool to update an existing contact in Fireberry CRM. Use when you need to modify contact information, billing address, shipping address, or related account details for an existing contact.

Input Parameters

string
required
The GUID of the contact to update. This uniquely identifies the contact record in Fireberry.
string
Fax
string
The GUID of the system user who created the record, can also be set manually. Will be used for permissions.
string
Job title
string
Last name
string
The related account’s GUID.
string
required
First name of the contact (Primary). This is a required field for updating a contact.
string
The related campaign’s GUID.
string
Department
string
Used for employee identification, unique values are recommended.
integer
Gender of the contact (Picklist). Numeric code indicating gender.
integer
Salutation (Picklist). Numeric code indicating the salutation.
string
Primary phone number, contains exclusively numbers.
string
Secondary phone number, contains exclusively numbers.
string
Third used phone number, contains exclusively numbers.
string
Website of the contact in URL format.
string
Billing city
string
Company name
string
Description of up to 4,000 characters.
string
Manager name
string
Billing state
string
Primary mobile phone number.
string
Secondary mobile phone number.
string
Shipping city
string
Billing street
string
Primary email address, must be in email format.
string
Secondary email address, must be in email format.
string
Third used email address, must be in email format.
string
Shipping state
string
Billing country
string
Billing zip code
string
The date and time of the last action related to the contact, must be in UTC format.
string
Shipping street
string
Shipping country
string
Shipping zip code
string
The GUID of the most recent email related to the contact.
integer
Sets if the contact is valid for emails (Picklist). Numeric code indicating email validity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_A_CONTRACTTool to update an existing contract in Fireberry. Use when you need to modify contract details such as name, dates, pricing, or service levels.

Input Parameters

string
required
The GUID of the contract to update. This is the unique identifier of the contract record.
number
Price of the contract. The total monetary value of the contract.
string
End date of contract in UTC format. The date when the contract expires.
string
The GUID of the system user who created the record, can also be set manually. Will be used for permissions.
string
Length of contract in months. The duration of the contract period.
string
The related account’s GUID. Links the contract to a specific account.
string
Start date of contract in UTC format. The date when the contract becomes active.
integer
State (Picklist). Numeric code representing the contract’s lifecycle state.
integer
Status (Picklist). Numeric code representing the contract’s current status.
string
Description of up to 4,000 characters. Detailed information about the contract.
string
required
Name (Primary) of the contract. This is the contract’s display name.
number
Monthly support hours. Number of support hours allocated per month.
string
Number of the contract. A unique identifier or reference number for the contract.
integer
Type of service (Picklist). Numeric code representing the type of service provided.
integer
Level of service (Picklist). Numeric code representing the service level tier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_ACTIVITY_LOGUpdate an existing Fireberry activity log, including its description, call destination, or related contact and object references. The related object ID and object type code must be provided together.

Input Parameters

string
required
The activity log’s GUID (globally unique identifier) to update.
string
The GUID of the system user who created the record. Can be set manually and will be used for permissions.
string
The related record’s GUID. Can belong to any editable system object type. If set, objecttypecode must also be set.
integer
The type of call (Picklist value).
string
The related contact’s GUID.
integer
The result of the call (Picklist value).
string
Description of the activity log (up to 4,000 characters).
integer
Object number of the object the related record belongs to. REQUIRED if objectid is set.
string
The phone number called.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_A_DATE_FIELDTool to update a date field configuration in Fireberry. Use when you need to modify date field properties such as label, default value, tracking settings, or additional properties (required/readonly).

Input Parameters

string
Field name used for system displays. This is the human-readable label shown in the UI.
boolean
To track all changes made to this field, enter ‘true’. When enabled, all modifications to this field will be logged.
string
required
The system name of the field being updated. This is the unique identifier for the date field.
integer
required
The number of the object the field being updated can be found in. This is the object type ID in Fireberry.
string
Value used by default for this field. Must match field requirements (date format).
string ("none" | "required" | "readonly")
Additional properties that can be set on a date field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_A_DATE_TIME_FIELDUpdate a Date & Time field’s properties in Fireberry, including its label, default value, required/readonly status, and change tracking. Tracking defaults to false and is sent unless explicitly omitted with null.

Input Parameters

string
Field name used for system displays. This is the human-readable label shown in the UI.
boolean
To track all changes made to this field, enter ‘true’. Defaults to false.
string
required
The system name of the field being updated. This is the internal field identifier.
integer
required
The number of the object the field being updated can be found in. This is the object type identifier.
string
Value used by default for this field. Must match field requirements and be in a valid date/time format.
string ("none" | "required" | "readonly")
Additional property options for the date/time field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_A_FORMULA_FIELDTool to update a formula field in Fireberry CRM. Use when you need to modify the formula calculation, field type, display label, or precision of an existing formula field.

Input Parameters

string
Field name used for system displays. This is the human-readable name shown in the UI.
string
The formula used to calculate the value of this field. Uses Fireberry formula syntax with functions like DATEDIFF, NOW, SUM, etc.
integer
Number between 0-4 to set the amount of digits after the decimal point. Only applicable for numeric field types.
string
required
The system name of the field being updated. This is the unique identifier for the formula field within the object type.
string
Set the result of the formula’s field type, such as text, number, date, etc. This determines how the calculated value is displayed and stored.
integer
required
The number of the object the field being updated can be found in. This identifies the entity type (e.g., 1 for accounts, 2 for contacts).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_A_HTML_FIELDUpdate an HTML field configuration in Fireberry, including its label, tracking setting, or required/read-only property. The tracking setting is sent as false by default unless explicitly set otherwise or omitted with null.

Input Parameters

string
Field name used for system displays.
boolean
To track all changes made to this field, enter ‘true’.
string
required
The system name of the field being updated.
integer
required
The number of the object the field being updated can be found in.
string ("none" | "required" | "readonly")
Additional properties that can be set on an HTML field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_A_MEETINGTool to update an existing meeting (activity) in Fireberry. Use when you need to modify meeting details such as subject, description, time, location, or related records.

Input Parameters

string
required
The GUID of the meeting activity to update.
string
The GUID of the system user who owns the record. Used for permissions.
string
required
The subject of the meeting (Primary field).
string
Location of the meeting.
string
The GUID of the record related to the meeting. If set, you MUST also set objecttitle and objecttypecode.
string
The GUID of the resource used for the meeting.
integer
Status of the meeting (Picklist integer code).
string
Description of the meeting, up to 4,000 characters.
string
Primary field of the related record. Required if objectid is set.
integer
Priority of the meeting (Picklist integer code).
string
Date and time the meeting ends (ISO 8601 format).
integer
Object number of the object the related record belongs to. Required if objectid is set.
string
Date and time the meeting starts (ISO 8601 format).
integer
The type of activity (Picklist integer code).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_AN_ARTICLEUpdates an existing article in Fireberry. Use this to modify article name, subject, body, description, or other article metadata. The article is identified by its GUID, and both articlename and articlesubject are required fields.

Input Parameters

string
required
The GUID of the article to update. This is a unique identifier for the article record.
string
The GUID of the system user who created the record, can also be set manually. Will be used for permissions.
integer
The state of the article. This is a picklist field represented as an integer.
integer
Editable number of times the article was viewed. Use this to manually set or update the view count.
integer
The status of the article. This is a picklist field represented as an integer.
string
Long text body of the article. This is the main content of the article.
string
required
Article name (Primary field). This is the main title or name of the article and is required.
string
Description of up to 4,000 characters. Additional descriptive text for the article.
integer
required
Set the topic of the article (Picklist, required). Numeric ID representing the subject/category of the article.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_AN_ASSETUpdate an existing asset (accountproduct) in Fireberry. Use when you need to modify asset details such as quantity, price, description, or other attributes.

Input Parameters

string
required
The GUID of the asset to update. This uniquely identifies the asset record in Fireberry.
number
Price of the asset.
string
The GUID of the system user who owns the record. Will be used for permissions.
number
Quantity of the selected product for this asset.
string
required
The GUID of the related account/customer who owns this asset.
string
required
The GUID of the related product that this asset represents.
string
UTC formatted date and time of expiration (e.g., ‘2024-12-31T23:59:59Z’).
integer
Status of the asset (Picklist). Use numeric codes that correspond to the status options in your Fireberry instance.
string
Description of the asset, up to 4,000 characters. Use this to add notes or details about the asset.
string
UTC formatted date and time of installation (e.g., ‘2024-01-15T10:00:00Z’).
string
Date and time of the purchase in UTC format (e.g., ‘2024-01-01T12:00:00Z’).
string
Used for identification of the asset. Unique values are recommended (e.g., serial number, asset tag).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_AN_EMAIL_ADDRESS_FIELDTool to update the configuration of an email address field in Fireberry. Use when you need to modify field properties such as label, required status, autocomplete behavior, or validation rules.

Input Parameters

string
Field name used for system displays. This is the human-readable label shown in the UI.
boolean
To track all changes made to this field, enter true. When enabled, field modifications will be logged in the audit trail.
string
required
The system name of the email address field being updated. This is the internal identifier for the field (e.g., ‘emailaddress1’, ‘emailaddress2’).
integer
Number between 1-200 to limit length of text. Sets the maximum number of characters allowed in the email address field.
integer
required
The number of the object the field being updated can be found in. This identifies the object type (e.g., 1 for contacts, 2 for accounts) where the email address field exists.
boolean
To autocomplete values for this field, enter true. When enabled, the system will suggest values as users type.
string
Value used by default for this field. Must match field requirements (valid email format).
string ("none" | "required" | "readonly")
Enum for additional property values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_AN_OPPORTUNITYTool to update an existing opportunity in Fireberry CRM. Use when you need to modify opportunity details such as name, estimated value, close date, status, or associated account.

Input Parameters

string
required
The GUID of the opportunity to update. This is the unique identifier of the opportunity record.
string
Name of the opportunity (Primary). The primary field for identifying the opportunity.
string
System user GUID for permissions. The GUID of the system user who owns the opportunity.
string
Related account’s GUID. Links this opportunity to a specific account/company.
string
Related contact’s GUID. Links this opportunity to a specific contact person.
integer
Status (Picklist). Integer code representing the opportunity status.
string
Description of up to 4,000 characters providing details about the opportunity.
number
Estimated revenue (float). The monetary value expected from this deal.
integer
Close probability value (0-100). Percentage representing likelihood of closing the deal.
string
Expected close date (UTC format). Use YYYY-MM-DD format for the date when the opportunity is expected to close.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_AN_ORDER_ITEMTool to update an existing order item in Fireberry. Use when you need to modify order item details such as product name, pricing, quantity, description, or related order.

Input Parameters

string
required
Use an Order Item’s globally unique identifier (GUID) to identify which order item to update.
integer
Use 2 to include VAT in the set itemprice, or use 1 to have it added on to the total price. (Picklist)
string
A system user’s GUID, will fill in automatically with the user who created the item and be used for permissions. Can be set manually.
number
Set the order the items will be listed in, will appear in ascending order starting with the lowest at the top.
number
Set the price of the product.
string
Use a product’s globally unique identifier (GUID) to switch the product related to this order item.
string
required
Use an Order’s globally unique identifier (GUID) to switch the order this item will appear in and be related to.
string
Free text description of the order item or product.
string
required
Set the name of a related or custom product.
number
Set the quantity of the product.
string
Set the catalog number of the product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_A_NUMBER_FIELDTool to update a number field configuration in Fireberry. Use when you need to modify number field properties such as label, precision, default value, tracking settings, or additional properties (required/readonly).

Input Parameters

string
Field name used for system displays. This is the human-readable label shown in the UI.
boolean
To track all changes made to this field, enter ‘true’. When enabled, all modifications to this field will be logged.
string
required
The system name of the field being updated. This is the unique identifier for the number field.
integer
Number between 0-4 to set the amount of digits after the decimal point. Defaults to 0 if not specified.
integer
required
The number of the object the field being updated can be found in. This is the object type ID in Fireberry.
string
Value used by default for this field. Must match field requirements (numeric format).
string ("none" | "required" | "readonly")
Additional properties that can be set on a number field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_A_PHONE_NUMBER_FIELDTool to update a phone number field configuration in Fireberry. Use when you need to modify phone number field properties such as label, display name, description, or required status.

Input Parameters

string
required
Display label for the phone field. This is the human-readable name shown in the UI. Required field.
string
required
The name identifier of the phone number field (e.g., ‘telephone1’, ‘telephone2’, ‘mobilephone’). This is the internal field name in Fireberry’s system.
boolean
Whether the phone field is mandatory. When true, users must provide a value for this field.
integer
required
The numeric object type ID in Fireberry (Account=1, Contact=2, Task=10, Activity=6). This identifies which object type the phone number field belongs to.
string
Field description providing additional context about the phone field. Maximum 4,000 characters.
string
User-friendly display name for the phone field. If not provided, defaults to the label value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_A_PRODUCTTool to update an existing product in Fireberry. Use when you need to modify product details such as name, catalog number, vendor information, or status.

Input Parameters

string
required
The GUID of the product to update. This is the unique identifier of the product record.
string
Name of the product. This is the display name that identifies the product.
string
Status code of the product. Represents the current status or state of the product in the system.
string
Name of the vendor or supplier for this product.
string
Catalog number for the product. Used for product identification and inventory tracking.
string
Custom system field 13. Additional product metadata field.
string
Vendor’s part number for this product. Used to reference the product in the vendor’s system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_A_PROJECTTool to update an existing project in Fireberry CRM. Use when you need to modify project details such as name, budget, due date, priority, or status.

Input Parameters

string
required
Use a project’s GUID. This is the unique identifier of the project record to update.
number
Budget allocated for the project.
string
Date the project must be completed by, use UTC format (YYYY-MM-DD).
string
The GUID of the system user who created the record, can also be set manually. Will be used for permissions.
integer
Priority (Picklist). Use integer code to set the priority level of the project (e.g., low, medium, high, critical).
string
The related account’s GUID. Links this project to a specific account in the system.
integer
Status (Picklist). Use integer code to set the current status of the project (e.g., planning, in progress, completed).
string
required
Name of the project (Primary). This is the required primary field for updating a project.
string
The related order’s GUID. Links this project to a specific order.
number
Estimated work time needed to complete the project (in hours).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_A_TEXT_AREA_FIELDUpdate a Text Area field’s properties in Fireberry, including its label, default value, required/readonly status, and change tracking. Tracking defaults to false and is sent unless explicitly omitted with null.

Input Parameters

string
Field name used for system displays. This is the human-readable label shown in the UI.
boolean
To track all changes made to this field, enter ‘true’. Defaults to false.
string
required
The system name of the field being updated. This is the internal field identifier.
integer
required
The number of the object the field being updated can be found in. This is the object type identifier.
string
Value used by default for this field. Must match field requirements.
string ("none" | "required" | "readonly")
Additional property options for the text area field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_A_TEXT_FIELDTool to update a text field configuration in Fireberry. Use when you need to modify text field properties such as label, default value, max length, autocomplete settings, tracking settings, or additional properties (required/readonly).

Input Parameters

string
Field name used for system displays. This is the human-readable label shown in the UI.
boolean
To track all changes made to this field, enter ‘true’. When enabled, all modifications to this field will be logged.
string
required
The system name of the field being updated. This is the unique identifier for the text field.
integer
Number between 1-200 to limit length of text. Specifies the maximum number of characters allowed in the field.
integer
required
The number of the object the field being updated can be found in. This is the object type ID in Fireberry.
boolean
To autocomplete values for this field, enter ‘true’. When enabled, the field will suggest values based on previous entries.
string
Value used by default for this field. Must match field requirements.
string ("none" | "required" | "readonly")
Additional properties that can be set on a text field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_A_TICKETTool to update an existing ticket (case) in Fireberry. Use when you need to modify ticket details such as title, status, priority, assignment, or description.

Input Parameters

string
required
The GUID of the ticket to update. This uniquely identifies the ticket record in Fireberry.
string
required
Ticket title (Primary). This is the main identifier and description of the ticket.
string
The GUID of the system user who created the record, can also be set manually. Will be used for permissions.
string
The related account’s GUID. Links the ticket to a specific customer account.
string
The related contact’s GUID. Links the ticket to a specific person within the account.
integer
Ticket state, such as open or closed (Picklist). Numeric code representing the lifecycle state of the ticket.
integer
Status (Picklist). Numeric code representing the detailed status of the ticket (e.g., in progress, waiting, resolved).
string
Description of up to 4,000 characters. Detailed explanation of the ticket issue or request.
string
The GUID of the system user the task is assigned to. Specifies who is responsible for resolving this ticket.
integer
Ticket type (Picklist). Numeric code categorizing the type of ticket (e.g., question, problem, request).
integer
Priority (Picklist). Numeric code indicating the urgency level of the ticket (e.g., low, medium, high, urgent).
integer
Ticket source (Picklist). Numeric code indicating how the ticket was created (e.g., phone, email, web form).
string
The related asset’s GUID. Links the ticket to a specific product or asset owned by the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_A_URL_FIELDTool to update a URL field configuration in Fireberry. Use when you need to modify URL field properties such as label, max length, default value, autocomplete settings, tracking, or additional properties (required/readonly).

Input Parameters

string
Field name used for system displays. This is the human-readable label shown in the UI.
boolean
To track all changes made to this field, enter ‘true’. When enabled, all modifications to this field will be logged.
string
required
The system name of the field being updated. This is the unique identifier for the URL field.
integer
Number between 1-200 to limit length of text. Specifies the maximum number of characters allowed in the URL field.
integer
required
The number of the object the field being updated can be found in. This is the object type ID in Fireberry.
boolean
To autocomplete values for this field, enter ‘true’. When enabled, the field will suggest values based on previous entries.
string
Value used by default for this field. Must match field requirements (valid URL format).
string ("none" | "required" | "readonly")
Additional properties that can be set on a URL field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_A_USERTool to update an existing user in Fireberry CRM. Use when you need to modify user details such as name, role, language preferences, or contact information.

Input Parameters

string
required
Must be a globally unique identifier (GUID) of the user to update.
string
Fax
string
The user’s SIPID from the organization’s call center.
integer
Sets the date time format displayed in this user’s system (Picklist).
string
required
The GUID of the role assigned to this user. Will control the user’s permissions.
string
Must be set as the GUID of this system user. Will be used for permissions.
number
Personal goal for this user.
string
Phone extension number
string
Job title
string
Last name
string
Time zone (Picklist)
string
required
Email address used to sign into the system.
string
required
First name of the user. This is a required field.
integer
Sets if the user is currently working (Picklist).
string
Employee ID
integer
required
Language the system will display in for this user. Can set 1037 for Hebrew or 1033 for English (Picklist).
integer
Salutation (Picklist)
string
Primary phone number
string
Secondary phone number
string
Third used phone number
string
Email address used to receive all emails from the system, will be used to reset the password of this user.
string
The user’s SIPID username.
string
The GUID of the business unit assigned to this user. May control the user’s sharing level.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_CAMPAIGNTool to update an existing campaign in Fireberry by its GUID. Use when you need to modify campaign details such as name, description, budget, dates, or status.

Input Parameters

string
required
The GUID of the campaign to update. Must be a valid campaign GUID identifier.
number
Cost - The actual cost incurred for the campaign.
number
Budget - The allocated budget amount for the campaign.
string
Date the campaign ends, use UTC format (YYYY-MM-DD).
string
The GUID of the system user who created the record, can also be set manually. Will be used for permissions.
integer
Type (Picklist) - Integer code representing the campaign type.
string
Date the campaign starts, use UTC format (YYYY-MM-DD).
integer
Type of media used (Picklist) - Integer code representing the media type.
integer
Status (Picklist) - Integer code representing the campaign status.
string
Description of up to 4,000 characters providing details about the campaign.
string
required
Name (Primary) - The campaign name, required field for identifying the campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_CRM_ORDERTool to update an existing CRM order in Fireberry. Use when you need to modify order details such as account information, items, pricing, discounts, or contact information.

Input Parameters

string
required
Use an Order’s globally unique identifier (GUID) to identify which order to update.
string
The fax number associated with the related account.
object
required
Add new order items to your order.
string
Full address of the related account.
string
A system user’s GUID, will fill in automatically with the user who created the order and be used for permissions. Can be set manually.
string
The ID number associated with the related account.
string
required
Use an Account’s globally unique identifier (GUID) to change the related account.
string
The phone number associated with the related account.
integer
Status of the order (Picklist)
string
required
Company name of the related account.
string
Free text description of the order.
integer
Set the number which represents the relevant currency. (Picklist)
string
The email address associated with the related account.
number
Set a number discount for the whole order. Will take precedence over the percentage field if both are set.
integer
To include VAT in the total enter 1, otherwise enter 0. Defaults to include VAT unless defined otherwise. (Picklist)
integer
To apply a round discount to the order enter 1, otherwise enter 2. Defaults to no discount. (Picklist)
number
Set a percentage discount for the whole order, if the amountdiscount is also set the percentage discount will not be applied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_PHONE_CALLTool to update an existing phone call record in Fireberry. Use when you need to modify call details such as status, type, duration, or associated contacts/accounts.

Input Parameters

string
required
The GUID of the phone call record to update.
string ("incoming" | "outgoing" | "internal")
Type codes for phone call records.
string ("answered" | "busy" | "missed" | "cancelled" | "disconnected_number" | "left_message")
Status codes for phone call records.
string
The GUID of the system user who created the record, can also be set manually. Will be used for permissions.
string
The phone number the call originated from (Primary).
number
The amount of time the phone rings until the line is connected or disconnected. Displays in seconds.
number
The duration of the call in seconds, does not include the dial time.
string
The phone number receiving the call.
string
The related account’s GUID.
string
The extension of the phone number the call originated from.
number
Price of the call.
string
The related contact’s GUID.
string
Queue name.
string
A link to a recording of the call, must be in URL format.
string
The extension of the receiving phone number.
string
Voice Mail box name.
string
required
The ID of the phone call. This field is required when updating a phone call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREBERRY_UPDATE_TASK2Tool to update an existing task using Fireberry v2 API. Use when you need to modify task details such as subject, status, priority, description, owner, or due date.

Input Parameters

string
required
The GUID of the task to update. This uniquely identifies the task record in Fireberry.
string
Task due date in UTC. Must be in valid date format (ISO 8601 recommended).
string
GUID of the assigned user. Determines who is responsible for completing this task.
string
The task subject/title. This is the main identifier and description of the task.
integer
Status code. Numeric code representing the status of the task (e.g., not started, in progress, completed).
string
Task description. Detailed explanation of the task requirements or notes.
integer
Priority level code. Numeric code indicating the priority level of the task (e.g., low, medium, high, urgent).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not