Update a Contact — Shilo API Reference

Use this endpoint to update the profile fields of an existing contact. All body fields are optional — only the fields you include will be modified, leaving the rest unchanged. You can identify the contact by their Shilo UUID or by your external contact ID. This endpoint requires a write-enabled API key.

Endpoint

PUT https://api.shilo.ai/api/v1/contacts/{identifier}

Authentication

Include your write-enabled API key in the request header:

x-api-key: YOUR_API_KEY

Path Parameters

string

required

The identifier used to look up the contact. Three formats are supported:

Format	Example
Plain Shilo UUID	`ee6f2136-b94a-4438-9335-3acf5b2a0d31`
Prefixed Shilo UUID	`id:ee6f2136-b94a-4438-9335-3acf5b2a0d31`
External contact ID	`external_contact_id:4534`

Request Body

All fields are optional. Submit only the fields you want to update.

string

Updated full display name for the contact.

string

Updated first name.

string

Updated last name.

string

Updated primary phone number. Any standard formatting is accepted.

string[]

Updated list of email addresses. This replaces the existing emails array in full.

string

Updated human-readable pipeline stage label.

string

Updated pipeline stage ID from your system.

string

Updated human-readable lead source label.

string

Updated lead source ID from your system.

string[]

Updated list of tags. This replaces the existing tags array in full.

Response

A successful request returns HTTP 200 with the full updated Contact object.

Response Fields

string

The Shilo-assigned UUID for this contact.

string

The contact ID from your external CRM or system of record.

string

Full display name of the contact.

string

Contact’s first name.

string

Contact’s last name.

string

Primary phone number.

array of strings

Email addresses associated with the contact.

string

Current pipeline stage label.

string

Pipeline stage ID from your system.

string

Lead source label.

string

Lead source ID from your system.

array of strings

Tags applied to the contact.

string

ISO-8601 timestamp indicating when this contact was created in Shilo.

Example Response

{
  "id": "ee6f2136-b94a-4438-9335-3acf5b2a0d31",
  "external_contact_id": "4534",
  "name": "Jamie Customer",
  "first_name": "Jamie",
  "last_name": "Customer",
  "phone": "(555) 555-0000",
  "emails": ["jamie.new@example.com"],
  "stage": "Closed Won",
  "stage_id": "stage-12",
  "source": "Zillow",
  "source_id": "src-7",
  "tags": ["closed", "q4"],
  "created_date": "2024-09-01T10:00:00Z"
}

Error Codes

Status	Meaning
`400`	Invalid request body or malformed identifier.
`403`	Your API key is read-only. A write-enabled key is required.

Example Request

curl -X PUT "https://api.shilo.ai/api/v1/contacts/external_contact_id:4534" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "(555) 555-0000",
    "emails": ["jamie.new@example.com"],
    "stage": "Closed Won",
    "stage_id": "stage-12",
    "tags": ["closed", "q4"]
  }'

Overview

Calls

Appointments

Roleplays

Contacts

Users

Invitations

Metrics

Coaching

Update a Contact — Shilo API Reference

Endpoint

Authentication

Path Parameters

Request Body

Response

Response Fields

Example Response

Error Codes

Example Request

​Endpoint

​Authentication

​Path Parameters

​Request Body

​Response

​Response Fields

​Example Response

​Error Codes

​Example Request

Endpoint

Authentication

Path Parameters

Request Body

Response

Response Fields

Example Response

Error Codes

Example Request