Update User

Update a User in an existing Organization

POST

/

public

/

v1

/

submit

/

update_user

Authorizations

API Key

X-Stamp

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_UPDATE_USER

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

parameters field

Show details

parameters.userId

string

required

Unique identifier for a given User.

parameters.userName

string

Human-readable name for a User.

parameters.userEmail

string

The user’s email address.

parameters.userTagIds · array

An updated list of User Tags to apply to this User. This field, if not needed, should be an empty array in your request body.

Show item details

Array item type: string

item field

parameters.userPhoneNumber

string

The user’s phone number in E.164 format e.g. [phone]

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.updateUserIntent

object

required

The updateUserIntent object

Show updateUserIntent details

activity.intent.updateUserIntent.userId

string

required

Unique identifier for a given User.

activity.intent.updateUserIntent.userName

string

Human-readable name for a User.

activity.intent.updateUserIntent.userEmail

string

The user’s email address.

activity.intent.updateUserIntent.userTagIds

array

An updated list of User Tags to apply to this User. This field, if not needed, should be an empty array in your request body.

Show userTagIds details

activity.intent.updateUserIntent.userTagIds.item

string

required

item field

activity.intent.updateUserIntent.userPhoneNumber

string

The user’s phone number in E.164 format e.g. [phone]

activity.result

object

required

The result of the activity

Show result details

activity.result.updateUserResult

object

required

The updateUserResult object

Show updateUserResult details

activity.result.updateUserResult.userId

string

required

A User ID.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/update_user \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_UPDATE_USER",
    "timestampMs": "<string> (e.g., 1745474677473)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "userId": "<string>",
        "userName": "<string>",
        "userEmail": "<string>",
        "userTagIds": [
            "<string_element>"
        ],
        "userPhoneNumber": "<string>"
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UPDATE_USER",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g., 1745474677473)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "updateUserIntent": {
            "userId": "<string>",
            "userName": "<string>",
            "userEmail": "<string>",
            "userTagIds": [
              "<string_element>"
            ],
            "userPhoneNumber": "<string>"
          }
        },
        "result": {
          "updateUserResult": {
            "userId": "<string>"
          }
        }
      }
    }
  }
}