Skip to content
Foldspace Developers

Update user

Open in ChatGPT Open in Claude
PUT
/v1/user/{identifyId}
 
curl --request PUT \
  --url https://api.foldspace.ai/v1/user/example \
  --header 'Content-Type: application/json' \
  --header 'X-FOLDSPACE-API-KEY: <X-FOLDSPACE-API-KEY>' \
  --data '{ "userType": "ANONYMOUS", "identifyId": "bTMwUidOQiZhMazBDWGAAmuRnu9N2", "email": "alice.johnson@foldspace.io", "name": "Alice Johnson", "role": "Admin", "phone": "+1-202-555-0147", "timezone": "America/New_York", "leadDate": 1734539909141, "signUpDate": 1734539909141, "firstVisitDate": 1734539909141, "lastSeenDate": 1731863535216, "lastSubscriptionIdentifier": "3a7d6f3b-8f1e-46b5-8731-c3e981e9abf7", "allSubscriptionIdentifiers": [ "example" ], "location": { "country": "United States", "region": "California", "state": "CA", "city": "San Francisco", "postalCode": "94107", "countryCode": "US" }, "customAttributes": { "additionalProperty": {} }, "products": [ { "product": "X7B69NRTTBM7", "environment": 1 } ], "image": "https://lh3.googleusercontent.com/a/AcBcq...", "pqlScore": 75.5 }'

Updates user information.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
identifyId
required
string

Unique identifier for the user

Request Body required

Section titled “Request Body required ”

User DTO for update. Certain fields like identifyId are not updatable.

Media type application/json

User Data Transfer Object

object
id

System-managed user ID (not updatable)

string
userType
required

Specifies user type (ANONYMOUS, LEAD, USER)

string
Allowed values: ANONYMOUS LEAD USER
identifyId
required

Unique identifier for the user (not updatable)

string
0 <= 255 characters
Example 
bTMwUidOQiZhMazBDWGAAmuRnu9N2
email

User’s email address

string
0 <= 255 characters
Example 
alice.johnson@foldspace.io
name

User’s display name

string
0 <= 255 characters /^[a-zA-Z0-9_ \-()]*$/
Example 
Alice Johnson
role

User’s role

string
0 <= 255 characters
Example 
Admin
phone

User’s phone number

string
0 <= 20 characters
Example 
+1-202-555-0147
timezone

User’s time zone

string
0 <= 50 characters
Example 
America/New_York
leadDate

Lead date in epoch milliseconds

integer format: int64
Example 
1734539909141
signUpDate

Sign-up date in epoch milliseconds

integer format: int64
Example 
1734539909141
lastModifiedDate

Last modified date (system-managed)

integer format: int64
firstVisitDate

First visit date in epoch milliseconds

integer format: int64
Example 
1734539909141
lastSeenDate

Last seen date in epoch milliseconds

integer format: int64
Example 
1731863535216
lastSubscriptionIdentifier

Last subscription identifier

string
0 <= 255 characters
Example 
3a7d6f3b-8f1e-46b5-8731-c3e981e9abf7
allSubscriptionIdentifiers

All subscription identifiers associated with the user

Array<string>
0 <= 100 items unique items
location

User location details

object
country

Location country

string
0 <= 128 characters
Example 
United States
region

Location region

string
0 <= 128 characters
Example 
California
state

Location state

string
0 <= 128 characters
Example 
CA
city

Location city

string
0 <= 128 characters
Example 
San Francisco
postalCode

Postal code

string
0 <= 128 characters
Example 
94107
countryCode

ISO country code

string
0 <= 8 characters
Example 
US
customAttributes

Custom attributes as map of key-value pairs

object
key
additional properties

Custom attributes as map of key-value pairs

object
products

Products associated with this user

Array<object>
0 <= 20 items unique items

Details about product and environment association

object
product

Product code

string
0 <= 16 characters
Example 
X7B69NRTTBM7
environment

Environment code (1=prod, 2=stage, 3=test, 4=dev)

integer format: int32
>= 1 <= 4
Example 
1
numberOfVisits

Number of visits (system-managed)

integer format: int32
image

Profile image URL

string
0 <= 255 characters
Example 
https://lh3.googleusercontent.com/a/AcBcq...
pqlScore

PQL score in the range 0.0 - 100.0

number format: double
<= 100
Example 
75.5

Responses

Section titled “ Responses ”

200

Section titled “200 ”

User updated successfully

Media type application/json
string
Example 
{
  "message": "User updated successfully"
}

400

Section titled “400 ”

Bad Request

Media type */*
string

401

Section titled “401 ”

Unauthorized

Media type */*
string

404

Section titled “404 ”

User not found

Media type */*
string

429

Section titled “429 ”

Rate limit exceeded for subscription

Media type */*
string
Example 
{
  "error": "Rate limit exceeded for subscription"
}

500

Section titled “500 ”

Internal server error

Media type */*
string