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)require "surge_api"
surge = SurgeAPI::Client.new(api_key: "My API Key")
user = surge.users.update("usr_01j9dwavghe1ttppewekjjkfrx", first_name: "Brian")
puts(user)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"
}
EOF<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.surge.app/users/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'first_name' => 'Brian',
'last_name' => 'O\'Conner',
'metadata' => [
'email' => 'boconner@toretti.family',
'user_id' => '1234'
],
'photo_url' => 'https://toretti.family/people/brian.jpg'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.surge.app/users/{id}"
payload := strings.NewReader("{\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}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<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)require "surge_api"
surge = SurgeAPI::Client.new(api_key: "My API Key")
user = surge.users.update("usr_01j9dwavghe1ttppewekjjkfrx", first_name: "Brian")
puts(user)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"
}
EOF<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.surge.app/users/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'first_name' => 'Brian',
'last_name' => 'O\'Conner',
'metadata' => [
'email' => 'boconner@toretti.family',
'user_id' => '1234'
],
'photo_url' => 'https://toretti.family/people/brian.jpg'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.surge.app/users/{id}"
payload := strings.NewReader("{\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}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<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
Path Parameters
Body
application/json
Response
Updated user
A user of the app