EAeasybroker
Contacts

Update a contact

Changed on

Updates an existing contact in your EasyBroker account. Only the fields you send are modified. For emails, phones, addresses and tags, the value you send fully replaces the current list — matching entries are preserved, missing entries are removed and new entries are appended (order is ignored).

patch/contacts/{contact_id}

Request

  • Base URL
    https://api.easybroker.com/v1
  • URL
    https://api.easybroker.com/v1/contacts/{contact_id}
  • Auth
    API key in header X-Authorization

Request body

first_namestring
last_namestring
titlestring
companystring
private_descriptionstring
sourcestring

The contact origin name. A new source is created if one with this name doesn't exist.

agentstring

The EasyBroker account email of the agent assigned to the contact.

probability'low' | 'medium' | 'high'

Lead probability level.

statusstring

One of your account's contact status names, exactly as shown on EasyBroker. A name that matches none or several of them returns a 422 error.

tagsstring[]

Replaces the contact's tag list with this exact set.

Example request

{
  "first_name": "John",
  "last_name": "Smith",
  "title": "Accountant",
  "company": "Smith LLC",
  "private_description": "One of our top clients.",
  "source": "mywebsite.com",
  "agent": "agent@example.com",
  "probability": "high",
  "status": "Contacted",
  "tags": [
    "priority",
    "top_client"
  ],
  "emails": [
    {
      "type": "Work",
      "email": "mail@example.com"
    }
  ],
  "phones": [
    {
      "type": "Mobile",
      "phone": "5559090909"
    }
  ],
  "addresses": [
    {
      "type": "Home",
      "street": "Main Street 19",
      "city": "Portland",
      "administrative_division": "Oregon",
      "country": "United States of America",
      "postal_code": "01234"
    }
  ]
}

Response

The contact was updated successfully

idinteger
full_namestring
first_namestring
last_namestring
titlestring
companystring
private_descriptionstring
tagsstring[]
sourcestring
probability'low' | 'medium' | 'high' nullable
statusstring nullable

The contact status name, exactly as shown on EasyBroker.

last_activity_atstring date-time nullable

When the last activity was recorded for the contact, such as a note, a message or a status change.

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": 123,
  "full_name": "John Smith",
  "first_name": "John",
  "last_name": "Smith",
  "title": "Accountant",
  "company": "Smith LLC",
  "private_description": "One of our top clients.",
  "tags": [
    "top_client",
    "priority"
  ],
  "source": "mywebsite.com",
  "probability": "high",
  "status": "Contacted",
  "last_activity_at": "2020-03-01T23:26:53.402Z",
  "agent": {
    "id": 1234,
    "name": "John Smith",
    "full_name": "John Smith Doe",
    "mobile_phone": "5555550000",
    "profile_image_url": "https://www.easybroker.com/assets/product/logo-be4da843987ccd1c05e26f8703f1787847471b36d08bdb1ec8a91ce4007b0e98.svg",
    "email": "john@smith.com"
  },
  "created_at": "2020-03-01T23:26:53.402Z",
  "updated_at": "2020-03-01T23:26:53.402Z",
  "emails": [
    {
      "type": "Work",
      "email": "mail@example.com"
    }
  ],
  "phones": [
    {
      "type": "Work",
      "phone": "5559090909"
    }
  ],
  "addresses": [
    {
      "type": "Work",
      "street": "Main Street 19",
      "city": "Portland",
      "administrative_division": "Oregon",
      "country": "United States of America",
      "postal_code": "01234"
    }
  ]
}

Changes

  • c4cce9eaa862Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status