Contacts

Update a contact

Updates a contact. Every field is optional, and anything you leave out keeps its current value.

This endpoint does not change which companies a contact is linked to.

patch/public-api/v1/contacts/{id}

Request

  • Base URL
    https://app.hellobonsai.com
  • URL
    https://app.hellobonsai.com/public-api/v1/contacts/{id}
  • Auth
    • OAuth 2
      Authorization code: https://app.hellobonsai.com/oauth/authorize
      Token URL: https://app.hellobonsai.com/oauth/token
    • or HTTP bearer

Path parameters

idinteger required

Id of the contact to update.

Request body

Example request

{
  "contact": {
    "name": "Alex Johnson",
    "email": "alex@example.com",
    "job_title": "CTO",
    "phone_number": "+1-415-555-0100"
  }
}

Response

The contact was updated.

Example response

{
  "data": {
    "id": 7,
    "name": "Alex Johnson",
    "email": "alex@example.com",
    "job_title": "CTO",
    "phone_number": "+1-415-555-0100",
    "archived_at": "2026-04-14T09:12:04.000Z",
    "created_at": "2026-04-14T09:12:04.000Z",
    "company_ids": [
      42
    ],
    "default_company_id": 42,
    "url": "https://app.hellobonsai.com/contacts/7"
  },
  "meta": {
    "request_id": "b1f0d2c4-7a9e-4c3b-8d5f-1e2a3b4c5d6e"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.