Skip to main content
POST
/
memory
/
{id}
/
add-user
Add a new user/phone number to an existing memory
curl --request POST \
  --url https://api.cleartalk.ai/memory/{id}/add-user \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "phone_number": "+1234567890",
  "metadata": "25 year old customer from New York",
  "summary": "The user described their age and location",
  "external_memory_key": "external_key_123"
}
'

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Path Parameters

​
id
string
required

Body

application/json
​
phone_number
string
required

The phone number of the user to add to the memory.

Example:

"+1234567890"

​
metadata
string

Custom metadata text to associate with this user in the memory.

Example:

"25 year old customer from New York"

​
summary
string

Initial summary text for this user's interactions.

Example:

"The user described their age and location"

​
external_memory_key
string

Optional external key for additional memory validation or cross-referencing.

Example:

"external_key_123"

Response

User added to memory successfully