Modify Identity

patch/v1/identities/{identity_id}

Modify Identity

Path ParametersExpand Collapse

identity_id: string

The ID of the identity in the format 'identity-'

minLength45

maxLength45

Body ParametersExpand Collapse

Deprecatedagent_ids: optional array of string

The agent ids that are associated with the identity.

Deprecatedblock_ids: optional array of string

The IDs of the blocks associated with the identity.

identifier_key: optional string

External, user-generated identifier key of the identity.

identity_type: optional IdentityType

Enum to represent the type of the identity.

Accepts one of the following:

"org"

"user"

"other"

name: optional string

The name of the identity.

properties: optional array of IdentityProperty { key, type, value }

List of properties associated with the identity.

key: string

The key of the property

type: "string" or "number" or "boolean" or "json"

The type of the property

Accepts one of the following:

"string"

"number"

"boolean"

"json"

value: string or number or boolean or map[unknown]

The value of the property

Accepts one of the following:

UnionMember0 = string

UnionMember1 = number

UnionMember2 = boolean

UnionMember3 = map[unknown]

ReturnsExpand Collapse

Identity = object { id, agent_ids, block_ids, 5 more }

id: string

The human-friendly ID of the Identity

Deprecatedagent_ids: array of string

The IDs of the agents associated with the identity.

Deprecatedblock_ids: array of string

The IDs of the blocks associated with the identity.

identifier_key: string

External, user-generated identifier key of the identity.

identity_type: IdentityType

The type of the identity.

Accepts one of the following:

"org"

"user"

"other"

name: string

The name of the identity.

project_id: optional string

The project id of the identity, if applicable.

properties: optional array of IdentityProperty { key, type, value }

List of properties associated with the identity

key: string

The key of the property

type: "string" or "number" or "boolean" or "json"

The type of the property

Accepts one of the following:

"string"

"number"

"boolean"

"json"

value: string or number or boolean or map[unknown]

The value of the property

Accepts one of the following:

UnionMember0 = string

UnionMember1 = number

UnionMember2 = boolean

UnionMember3 = map[unknown]

Modify Identity

curl https://api.letta.com/v1/identities/$IDENTITY_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $LETTA_API_KEY" \
    -d '{}'

{
  "id": "identity-123e4567-e89b-12d3-a456-426614174000",
  "agent_ids": [
    "string"
  ],
  "block_ids": [
    "string"
  ],
  "identifier_key": "identifier_key",
  "identity_type": "org",
  "name": "name",
  "project_id": "project_id",
  "properties": [
    {
      "key": "key",
      "type": "string",
      "value": "string"
    }
  ]
}

Returns Examples

{
  "id": "identity-123e4567-e89b-12d3-a456-426614174000",
  "agent_ids": [
    "string"
  ],
  "block_ids": [
    "string"
  ],
  "identifier_key": "identifier_key",
  "identity_type": "org",
  "name": "name",
  "project_id": "project_id",
  "properties": [
    {
      "key": "key",
      "type": "string",
      "value": "string"
    }
  ]
}