Copper

Create Copper Person

Adds a new person to Copper.

Unverified

What the model is told

Create a new person in Copper. Confirm the name, email address and phone number with the customer first, and check with Find Copper Person by Email that they do not already exist. Returns the new person including their ID.

Request

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

Headers

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

Body

{
  "name": "{{name}}",
  "emails": [
    {
      "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": "8b073048-b84c-42b1-b5b5-93691c8f34a5",
    "type": "HTTP_REQUEST",
    "label": "Create Copper Person",
    "name": "create_copper_person",
    "customName": false,
    "description": "Create a new person in Copper. Confirm the name, email address and phone number with the customer first, and check with Find Copper Person by Email that they do not already exist. Returns the new person including their ID.",
    "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/people"
      },
      "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  \"emails\": [\n    {\n      \"email\": \"{{email}}\",\n      \"category\": \"work\"\n    }\n  ],\n  \"phone_numbers\": [\n    {\n      \"number\": \"{{phone}}\",\n      \"category\": \"mobile\"\n    }\n  ]\n}",
      "timeout": null
    }
  }
}

IDs are regenerated on every copy.