Freshworks CRM

Create Freshworks CRM Deal

Opens a new deal in Freshworks CRM linked to a contact.

Unverified

What the model is told

Create a new deal for an existing Freshworks CRM contact, for example when the customer wants a quote. Confirm the deal name with the customer first. Find the contact's ID first with Find Freshworks CRM Contact by Email. Returns the new deal.

Request

POSThttps://YOUR_DOMAIN.myfreshworks.com/crm/sales/api/deals

Headers

  • AuthorizationToken token=YOUR_FRESHWORKS_API_KEY
  • Content-Typeapplication/json

Body

{
  "deal": {
    "name": "{{name}}",
    "contacts_added_list": [
      "{{contactId}}"
    ]
  }
}

Parameters

  • name stringA short name for the deal.
  • contactId stringThe Freshworks CRM ID of the contact, from Find Freshworks CRM Contact by Email.

Engage payload

{
  "source": "VOICE_AI",
  "tool": {
    "id": "f3d9cfe1-60c2-49ed-8a37-fc448b6011c7",
    "type": "HTTP_REQUEST",
    "label": "Create Freshworks CRM Deal",
    "name": "create_freshworks_crm_deal",
    "customName": false,
    "description": "Create a new deal for an existing Freshworks CRM contact, for example when the customer wants a quote. Confirm the deal name with the customer first. Find the contact's ID first with Find Freshworks CRM Contact by Email. Returns the new deal.",
    "parameters": [
      {
        "name": "name",
        "type": "string",
        "description": "A short name for the deal."
      },
      {
        "name": "contactId",
        "type": "string",
        "description": "The Freshworks CRM ID of the contact, from Find Freshworks CRM Contact by Email."
      }
    ],
    "config": {
      "endpoint": {
        "method": "POST",
        "url": "https://YOUR_DOMAIN.myfreshworks.com/crm/sales/api/deals"
      },
      "headers": [
        {
          "name": "Authorization",
          "value": "Token token=YOUR_FRESHWORKS_API_KEY"
        },
        {
          "name": "Content-Type",
          "value": "application/json"
        }
      ],
      "body": "{\n  \"deal\": {\n    \"name\": \"{{name}}\",\n    \"contacts_added_list\": [\n      \"{{contactId}}\"\n    ]\n  }\n}",
      "timeout": null
    }
  }
}

IDs are regenerated on every copy.