JavaScript
import Surge from '@surgeapi/node';
const client = new Surge({
apiKey: process.env['SURGE_API_KEY'], // This is the default and can be omitted
});
const user = await client.users.update('usr_01j9dwavghe1ttppewekjjkfrx', { first_name: 'Brian' });
console.log(user.id);import os
from surge import Surge
client = Surge(
api_key=os.environ.get("SURGE_API_KEY"), # This is the default and can be omitted
)
user = client.users.update(
id="usr_01j9dwavghe1ttppewekjjkfrx",
first_name="Brian",
)
print(user.id)package main
import (
"context"
"fmt"
"github.com/stainless-sdks/surge-go"
"github.com/stainless-sdks/surge-go/option"
)
func main() {
client := surge.NewClient(
option.WithAPIKey("My API Key"),
)
user, err := client.Users.Update(
context.TODO(),
"usr_01j9dwavghe1ttppewekjjkfrx",
surge.UserUpdateParams{
FirstName: "Brian",
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", user.ID)
}
require "surge_api"
surge = SurgeAPI::Client.new(api_key: "My API Key")
user = surge.users.update("usr_01j9dwavghe1ttppewekjjkfrx", first_name: "Brian")
puts(user)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Surge\Client;
use Surge\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('SURGE_API_KEY') ?: 'My API Key');
try {
$user = $client->users->update(
'usr_01j9dwavghe1ttppewekjjkfrx',
firstName: 'Brian',
lastName: 'O\'Conner',
metadata: ['email' => 'boconner@toretti.family', 'user_id' => '1234'],
photoURL: 'https://toretti.family/people/brian.jpg',
);
var_dump($user);
} catch (APIException $e) {
echo $e->getMessage();
}curl --request PATCH \
--url https://api.surge.app/users/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"first_name": "Brian",
"last_name": "O'Conner",
"metadata": {
"email": "boconner@toretti.family",
"user_id": "1234"
},
"photo_url": "https://toretti.family/people/brian.jpg"
}
EOFHttpResponse<String> response = Unirest.patch("https://api.surge.app/users/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"Brian\",\n \"last_name\": \"O'Conner\",\n \"metadata\": {\n \"email\": \"boconner@toretti.family\",\n \"user_id\": \"1234\"\n },\n \"photo_url\": \"https://toretti.family/people/brian.jpg\"\n}")
.asString();{
"first_name": "Brian",
"id": "usr_01j9dwavghe1ttppewekjjkfrx",
"last_name": "O'Conner",
"metadata": {
"email": "boconner@toretti.family",
"user_id": "1234"
},
"photo_url": "https://toretti.family/people/brian.jpg"
}{
"error": {
"message": "The requested resource could not be found.",
"type": "not_found"
}
}Users
Update user
Update a user’s name or custom metadata.
PATCH
/
users
/
{id}
JavaScript
import Surge from '@surgeapi/node';
const client = new Surge({
apiKey: process.env['SURGE_API_KEY'], // This is the default and can be omitted
});
const user = await client.users.update('usr_01j9dwavghe1ttppewekjjkfrx', { first_name: 'Brian' });
console.log(user.id);import os
from surge import Surge
client = Surge(
api_key=os.environ.get("SURGE_API_KEY"), # This is the default and can be omitted
)
user = client.users.update(
id="usr_01j9dwavghe1ttppewekjjkfrx",
first_name="Brian",
)
print(user.id)package main
import (
"context"
"fmt"
"github.com/stainless-sdks/surge-go"
"github.com/stainless-sdks/surge-go/option"
)
func main() {
client := surge.NewClient(
option.WithAPIKey("My API Key"),
)
user, err := client.Users.Update(
context.TODO(),
"usr_01j9dwavghe1ttppewekjjkfrx",
surge.UserUpdateParams{
FirstName: "Brian",
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", user.ID)
}
require "surge_api"
surge = SurgeAPI::Client.new(api_key: "My API Key")
user = surge.users.update("usr_01j9dwavghe1ttppewekjjkfrx", first_name: "Brian")
puts(user)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Surge\Client;
use Surge\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('SURGE_API_KEY') ?: 'My API Key');
try {
$user = $client->users->update(
'usr_01j9dwavghe1ttppewekjjkfrx',
firstName: 'Brian',
lastName: 'O\'Conner',
metadata: ['email' => 'boconner@toretti.family', 'user_id' => '1234'],
photoURL: 'https://toretti.family/people/brian.jpg',
);
var_dump($user);
} catch (APIException $e) {
echo $e->getMessage();
}curl --request PATCH \
--url https://api.surge.app/users/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"first_name": "Brian",
"last_name": "O'Conner",
"metadata": {
"email": "boconner@toretti.family",
"user_id": "1234"
},
"photo_url": "https://toretti.family/people/brian.jpg"
}
EOFHttpResponse<String> response = Unirest.patch("https://api.surge.app/users/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"Brian\",\n \"last_name\": \"O'Conner\",\n \"metadata\": {\n \"email\": \"boconner@toretti.family\",\n \"user_id\": \"1234\"\n },\n \"photo_url\": \"https://toretti.family/people/brian.jpg\"\n}")
.asString();{
"first_name": "Brian",
"id": "usr_01j9dwavghe1ttppewekjjkfrx",
"last_name": "O'Conner",
"metadata": {
"email": "boconner@toretti.family",
"user_id": "1234"
},
"photo_url": "https://toretti.family/people/brian.jpg"
}{
"error": {
"message": "The requested resource could not be found.",
"type": "not_found"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the user to update.
Example:
"usr_01j9dwavghe1ttppewekjjkfrx"
Body
application/json
Response
Updated user
A user of the app
The user's first name.
Unique identifier for the object.
The user's last name.
Set of key-value pairs that will be stored with the object.
Show child attributes
Show child attributes
URL of a photo to be used as the user's avatar.
⌘I