Update a contact (Beta)

> ## Documentation Index
> Fetch the complete documentation index at: https://easybroker-staging.readme.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a contact (Beta)

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). This endpoint is still in beta, please contact our support team if you have any problem or want to share any feedback.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0",
    "title": "EasyBroker API",
    "description": "API for accessing and working with EasyBroker accounts. To get started click the Authorize button below and enter your API key."
  },
  "externalDocs": {
    "description": "View the getting started guide in Spanish",
    "url": "https://dev.easybroker.com/docs/api-de-easybroker"
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "servers": [
    {
      "url": "https://api.stagingeb.com/v1",
      "description": "API URL"
    }
  ],
  "paths": {
    "/contacts/{contact_id}": {
      "parameters": [
        {
          "name": "contact_id",
          "in": "path",
          "required": true,
          "description": "The ID of the specified contact",
          "schema": {
            "type": "number"
          }
        }
      ],
      "patch": {
        "tags": [
          "Contacts"
        ],
        "summary": "Update a contact (Beta)",
        "description": "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). This endpoint is still in beta, please contact our support team if you have any problem or want to share any feedback.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ContactBody"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The contact was updated successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ContactSingle"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "404": {
            "$ref": "#/components/responses/contact_not_found"
          },
          "422": {
            "description": "The contact couldn't be updated because it is invalid",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "object",
                      "example": {
                        "first_name": [
                          "is too long"
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "responses": {
      "contact_not_found": {
        "description": "No contact was found with the provided ID",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string",
                  "example": "The contact couldn't be found"
                }
              }
            }
          }
        }
      },
      "UnauthorizedError": {
        "description": "API key is missing or invalid",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string",
                  "example": "Your API key is invalid"
                }
              }
            }
          }
        }
      }
    },
    "schemas": {
      "Agent": {
        "properties": {
          "id": {
            "type": "integer",
            "example": 1234
          },
          "name": {
            "type": "string",
            "example": "John Smith"
          },
          "full_name": {
            "type": "string",
            "example": "John Smith Doe"
          },
          "mobile_phone": {
            "type": "string",
            "example": "5555550000"
          },
          "profile_image_url": {
            "type": "string",
            "example": "https://www.easybroker.com/assets/product/logo-be4da843987ccd1c05e26f8703f1787847471b36d08bdb1ec8a91ce4007b0e98.svg"
          },
          "email": {
            "type": "string",
            "example": "john@smith.com"
          }
        }
      },
      "ContactSingle": {
        "properties": {
          "id": {
            "type": "number",
            "example": "123"
          },
          "full_name": {
            "type": "string",
            "example": "John Smith"
          },
          "first_name": {
            "type": "string",
            "example": "John"
          },
          "last_name": {
            "type": "string",
            "example": "Smith"
          },
          "title": {
            "type": "string",
            "example": "Accountant"
          },
          "company": {
            "type": "string",
            "example": "Smith LLC"
          },
          "private_description": {
            "type": "string",
            "example": "One of our top clients."
          },
          "tags": {
            "type": "array",
            "example": [
              "top_client",
              "priority"
            ],
            "items": {
              "type": "string"
            }
          },
          "source": {
            "type": "string",
            "example": "mywebsite.com"
          },
          "probability": {
            "type": "string",
            "nullable": true,
            "enum": [
              "low",
              "medium",
              "high"
            ],
            "example": "high"
          },
          "agent": {
            "$ref": "#/components/schemas/Agent"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "example": "2020-03-01T23:26:53.402Z"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "example": "2020-03-01T23:26:53.402Z"
          },
          "emails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ContactEmails"
            }
          },
          "phones": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ContactPhones"
            }
          },
          "addresses": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ContactAddresses"
            }
          }
        }
      },
      "ContactEmails": {
        "properties": {
          "type": {
            "type": "string",
            "example": "Work",
            "enum": [
              "Personal",
              "Work",
              "Other"
            ],
            "description": "The contact email type"
          },
          "email": {
            "type": "string",
            "example": "mail@example.com"
          }
        }
      },
      "ContactPhones": {
        "properties": {
          "type": {
            "type": "string",
            "example": "Work",
            "enum": [
              "Home",
              "Work",
              "Mobile",
              "Home fax",
              "Work fax",
              "Pager",
              "Nextel",
              "WhatsApp"
            ],
            "description": "The contact phone type"
          },
          "phone": {
            "type": "string",
            "example": "5559090909"
          }
        }
      },
      "ContactAddresses": {
        "properties": {
          "type": {
            "type": "string",
            "example": "Work",
            "enum": [
              "Home",
              "Work",
              "Other"
            ],
            "description": "The contact addresses type"
          },
          "street": {
            "type": "string",
            "example": "Main Street 19"
          },
          "city": {
            "type": "string",
            "example": "Portland"
          },
          "administrative_division": {
            "type": "string",
            "example": "Oregon"
          },
          "country": {
            "type": "string",
            "example": "United States of America"
          },
          "postal_code": {
            "type": "string",
            "example": "01234"
          }
        }
      },
      "ContactEmailBody": {
        "properties": {
          "type": {
            "type": "string",
            "example": "Work",
            "description": "The contact email type (e.g. Home, Work, Other)."
          },
          "email": {
            "type": "string",
            "example": "mail@example.com"
          }
        }
      },
      "ContactPhoneBody": {
        "properties": {
          "type": {
            "type": "string",
            "example": "Mobile",
            "description": "The contact phone type (e.g. Home, Work, Mobile, Pager, Home fax, Work fax)."
          },
          "phone": {
            "type": "string",
            "example": "5559090909"
          }
        }
      },
      "ContactAddressBody": {
        "properties": {
          "type": {
            "type": "string",
            "example": "Home",
            "description": "The contact address type (e.g. Home, Work, Other)."
          },
          "street": {
            "type": "string",
            "example": "Main Street 19"
          },
          "city": {
            "type": "string",
            "example": "Portland"
          },
          "administrative_division": {
            "type": "string",
            "example": "Oregon"
          },
          "country": {
            "type": "string",
            "example": "United States of America",
            "description": "Country name (English or Spanish) or two-letter code."
          },
          "postal_code": {
            "type": "string",
            "example": "01234"
          }
        }
      },
      "ContactBody": {
        "properties": {
          "first_name": {
            "type": "string",
            "example": "John"
          },
          "last_name": {
            "type": "string",
            "example": "Smith"
          },
          "title": {
            "type": "string",
            "example": "Accountant"
          },
          "company": {
            "type": "string",
            "example": "Smith LLC"
          },
          "private_description": {
            "type": "string",
            "example": "One of our top clients."
          },
          "source": {
            "type": "string",
            "example": "mywebsite.com",
            "description": "The contact origin name. A new source is created if one with this name doesn't exist."
          },
          "agent": {
            "type": "string",
            "example": "agent@example.com",
            "description": "The EasyBroker account email of the agent assigned to the contact."
          },
          "probability": {
            "type": "string",
            "enum": [
              "low",
              "medium",
              "high"
            ],
            "example": "high",
            "description": "Lead probability level."
          },
          "tags": {
            "type": "array",
            "example": [
              "priority",
              "top_client"
            ],
            "description": "Replaces the contact's tag list with this exact set.",
            "items": {
              "type": "string"
            }
          },
          "emails": {
            "type": "array",
            "description": "Replaces the contact's emails with this exact list (existing entries with matching type and email are preserved; missing entries are removed).",
            "items": {
              "$ref": "#/components/schemas/ContactEmailBody"
            }
          },
          "phones": {
            "type": "array",
            "description": "Replaces the contact's phone numbers with this exact list (matching is done by type and digits, ignoring formatting).",
            "items": {
              "$ref": "#/components/schemas/ContactPhoneBody"
            }
          },
          "addresses": {
            "type": "array",
            "description": "Replaces the contact's addresses with this exact list.",
            "items": {
              "$ref": "#/components/schemas/ContactAddressBody"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Authorization",
        "description": "You can find your API key in the general settings section of your EasyBroker account. It's only accessible for account administrators."
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 99,
      "1": 142,
      "2": 110,
      "3": 111,
      "4": 217,
      "5": 194,
      "6": 135,
      "7": 0,
      "8": 24,
      "9": 185,
      "10": 196,
      "11": 37
    }
  }
}
```