Skip to main content
PUT
/
identities
/
{identity_uid}
Update one identity by UID.
curl --request PUT \
  --url https://api.edges.run/v1/identities/{identity_uid} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "timezone": "Europe/Paris",
  "name": "John Doe"
}
'
{
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2023-10-01T12:00:00Z",
  "workspace_uid": "5678e456-e89b-12d3-a456-426614174001",
  "name": "John Doe",
  "type": "standard",
  "timezone": "Europe/Paris",
  "is_active": "false",
  "integrations": []
}

Documentation Index

Fetch the complete documentation index at: https://docs.edges.run/llms.txt

Use this file to discover all available pages before exploring further.

Update an identity’s name and timezone. You can modify these fields at any time after creation.
Identity type cannot be changed: The type field (standard or engagement) is set during creation and cannot be modified via the update endpoint. If you need to change an identity’s type, you must:
  1. Delete the existing identity using the Delete an Identity endpoint
  2. Create a new identity with the desired type using the Create an Identity endpoint
Before deleting an identity to change its type, make sure to:
  • Note any connected integrations (you’ll need to reconnect them to the new identity)
  • Consider the impact on any scheduled actions or workflows
  • Be aware that deleting an engagement identity may affect your monthly billing cycle

Authorizations

​
X-API-Key
string
header
required

API key required for authentication. Add your API key in the X-API-Key header.

Path Parameters

​
identity_uid
string<uuid>
required

Body

application/json
​
name
string
required

Name of the identity. Must be at least 3 characters long.

Minimum string length: 3
​
timezone
string
default:Europe/Paris

IANA-compliant timezone identifier used to localize timestamps. Follows the IANA time zone database (e.g. America/New_York, Europe/London)

Response

Identity successfully updated.

​
workspace_uid
string<uuid>
required
​
timezone
string
required
​
type
enum<string>
required
Available options:
standard,
engagement
​
uid
string<uuid>
​
created_at
string<date-time>
​
name
string | null
​
is_active
boolean
default:false
​
integrations
string[]