Update a user

PUT 
https://embedded.runalloy.com/2024-03//users/:userId

Updates a user given a specified userId. This endpoint allows you to update a username or fullName and returns the updated user object.

Request

Path Parameters

userId stringrequired

The Id of the user you want to lookup. Returned from the Create User endpoint. Note: you can also use the Embedded user's username in this field.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

application/json

Body

username string

The unique identifier of the user

fullName string

The name of the user

Responses

200

200

application/json

Schema

Schema

userId string
fullName string
username string

Example (from schema)

{
  "userId": "6323d7c9122ae69742a5d0a2",
  "fullName": "Gregg Mojica",
  "username": "greggmojica"
}

Result

{
    "userId": "6323d7c9122ae69742a5d0a2",
    "fullName": "Gregg Mojica",
    "username": "greggmojica"
}

401

401

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Unauthorized"
}

Result

{
  "message":"Unauthorized"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT 'https://embedded.runalloy.com/2024-03/users/:userId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "username": "string",
  "fullName": "string"
}'

Request Collapse all

Base URL

https://embedded.runalloy.com/2024-03

Parameters

userId — pathrequired

Authorization — headerrequired

Body

{
  "username": "string",
  "fullName": "string"
}

ResponseClear

Click the Send API Request button above and see the response here!