Copper

Create Copper Lead

Adds a new lead to Copper.

Unverified

What the model is told

Create a new lead in Copper. Confirm the name, email address and phone number with the customer first. Returns the new lead including its ID. Tell the customer their details have been passed to the team.

Request

POSThttps://api.copper.com/developer_api/v1/leads

Headers

  • X-PW-AccessTokenYOUR_COPPER_API_KEY
  • X-PW-Applicationdeveloper_api
  • X-PW-UserEmailYOUR_COPPER_USER_EMAIL
  • Content-Typeapplication/json

Body

{
  "name": "{{name}}",
  "email": {
    "email": "{{email}}",
    "category": "work"
  },
  "phone_numbers": [
    {
      "number": "{{phone}}",
      "category": "mobile"
    }
  ]
}

Parameters

  • name stringThe customer's full name.
  • email stringThe customer's email address.
  • phone stringThe customer's phone number in international format.

Engage payload

{
  "source": "VOICE_AI",
  "tool": {
    "id": "6e2e90a7-64c0-4525-b82c-134e9c210885",
    "type": "HTTP_REQUEST",
    "label": "Create Copper Lead",
    "name": "create_copper_lead",
    "customName": false,
    "description": "Create a new lead in Copper. Confirm the name, email address and phone number with the customer first. Returns the new lead including its ID. Tell the customer their details have been passed to the team.",
    "parameters": [
      {
        "name": "name",
        "type": "string",
        "description": "The customer's full name."
      },
      {
        "name": "email",
        "type": "string",
        "description": "The customer's email address."
      },
      {
        "name": "phone",
        "type": "string",
        "description": "The customer's phone number in international format."
      }
    ],
    "config": {
      "endpoint": {
        "method": "POST",
        "url": "https://api.copper.com/developer_api/v1/leads"
      },
      "headers": [
        {
          "name": "X-PW-AccessToken",
          "value": "YOUR_COPPER_API_KEY"
        },
        {
          "name": "X-PW-Application",
          "value": "developer_api"
        },
        {
          "name": "X-PW-UserEmail",
          "value": "YOUR_COPPER_USER_EMAIL"
        },
        {
          "name": "Content-Type",
          "value": "application/json"
        }
      ],
      "body": "{\n  \"name\": \"{{name}}\",\n  \"email\": {\n    \"email\": \"{{email}}\",\n    \"category\": \"work\"\n  },\n  \"phone_numbers\": [\n    {\n      \"number\": \"{{phone}}\",\n      \"category\": \"mobile\"\n    }\n  ]\n}",
      "timeout": null
    }
  }
}

IDs are regenerated on every copy.