Update User Email — Shilo API Reference

Use this endpoint to change the email address associated with a Shilo user account. Email updates are handled through a dedicated endpoint — separate from the general profile update — because changing a user’s email may trigger downstream notifications and identity-related processes within Shilo. This endpoint requires a write-enabled API key.

Endpoint

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

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 user. Three formats are supported:

Format	Example
Plain Shilo UUID	`ee6f2136-b94a-4438-9335-3acf5b2a0d31`
Prefixed Shilo UUID	`id:ee6f2136-b94a-4438-9335-3acf5b2a0d31`
External user ID	`external_user_id:agent-1`

Request Body

string

required

The user’s current email address. Used to identify the account being updated.

string

required

The new email address to assign to this user. Must be a valid email format.

Example Body

{
  "existing_email": "alex@example.com",
  "updated_email": "alex.new@example.com"
}

Response

A successful request returns HTTP 200 with the full updated User object reflecting the new email address.

Response Fields

string

The Shilo-assigned UUID for this user.

string

The user’s external system ID.

string

Full display name of the user.

string

The updated primary email address of the user.

string

The user’s configured timezone.

string

URL of the user’s profile picture.

string

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

Example Response

{
  "id": "ee6f2136-b94a-4438-9335-3acf5b2a0d31",
  "external_user_id": "agent-1",
  "name": "Alex User",
  "email": "alex.new@example.com",
  "timezone": "America/New_York",
  "picture": "https://cdn.shilo.ai/avatars/ee6f2136.png",
  "created_date": "2024-01-15T09:00:00Z"
}

Error Codes

Status	Meaning
`400`	Invalid request body, missing `existing_email` or `updated_email`, or malformed identifier.
`403`	Your API key is read-only. A write-enabled key is required.
`404`	No user found matching the provided identifier.

Example Request

curl -X PUT "https://api.shilo.ai/api/v1/users/ee6f2136-b94a-4438-9335-3acf5b2a0d31/update_email" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "existing_email": "alex@example.com",
    "updated_email": "alex.new@example.com"
  }'

Using external user ID

curl -X PUT "https://api.shilo.ai/api/v1/users/external_user_id:agent-1/update_email" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "existing_email": "alex@example.com",
    "updated_email": "alex.new@example.com"
  }'

Overview

Calls

Appointments

Roleplays

Contacts

Users

Invitations

Metrics

Coaching

Update User Email — Shilo API Reference

Endpoint

Authentication

Path Parameters

Request Body

Example Body

Response

Response Fields

Example Response

Error Codes

Example Request

Using external user ID

​Endpoint

​Authentication

​Path Parameters

​Request Body

​Example Body

​Response

​Response Fields

​Example Response

​Error Codes

​Example Request

​Using external user ID

Endpoint

Authentication

Path Parameters

Request Body

Example Body

Response

Response Fields

Example Response

Error Codes

Example Request

Using external user ID