Skip to main content
PATCH
Update an identity

Authorizations

Authorization
string
header
required

Your secret key (pep_sk_…) from Settings → API. Keys are org-scoped; treat them like passwords.

Path Parameters

id
integer
required

Body

application/json
name
string
from_local
string

Local part on the platform's verified sending domain.

reply_to
string
copy_to
string
signature
string
agents
string[]

Agent slugs to assign as wearers.

Response

The updated identity.

object
string
required
Allowed value: "identity"
id
integer
required
name
string
required
agents
string[]
required

Slugs of the agents acting as this identity.

archived
boolean
required
created_at
string<date-time>
required
from_local
string | null
reply_to
string | null
copy_to
string | null
signature
string | null