Upsert Identity Properties

client.identities.properties.upsert(, , ?): PropertyUpsertResponse

put/v1/identities/{identity_id}/properties

ParametersExpand Collapse

identityID: string

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

minLength45

maxLength45

params: PropertyUpsertParams { body }

body: Array<IdentityProperty { key, type, value } >

key: string

The key of the property

type: "string" | "number" | "boolean" | "json"

The type of the property

Accepts one of the following:

"string"

"number"

"boolean"

"json"

value: string | number | boolean | Record<string, unknown>

The value of the property

Accepts one of the following:

string

number

boolean

Record<string, unknown>

ReturnsExpand Collapse

PropertyUpsertResponse = unknown

Upsert Identity Properties

import Letta from '@letta-ai/letta-client';

const client = new Letta({
  apiKey: 'My API Key',
});

const response = await client.identities.properties.upsert('identity-123e4567-e89b-42d3-8456-426614174000', {
  body: [{ key: 'key', type: 'string', value: 'string' }],
});

console.log(response);

{}

Returns Examples

{}