Skip to main content
PUT
/
client
/
user
Update user
curl --request PUT \
  --url https://api.orbital-systems.com/client/user \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "address": {
    "city": "<string>",
    "country": "<string>",
    "street": "<string>",
    "zip_code": "<string>"
  },
  "company": "<string>",
  "firstname": "<string>",
  "lastname": "<string>",
  "notification_app": true,
  "notification_email": true,
  "notification_interval": "<string>",
  "notifications": [
    "<string>"
  ],
  "phone_number": "<string>",
  "volume_unit": "<string>",
  "temperature_unit": "<string>",
  "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_id": "<string>",
  "consent": true,
  "google_home": true,
  "dark_theme": true,
  "use_phone_theme": true,
  "automatic_timezone": true,
  "routines": [
    "<string>"
  ],
  "locale": "<string>",
  "sharing_requests": true,
  "updated_at": "<string>"
}
'
import requests

url = "https://api.orbital-systems.com/client/user"

payload = {
"address": {
"city": "<string>",
"country": "<string>",
"street": "<string>",
"zip_code": "<string>"
},
"company": "<string>",
"firstname": "<string>",
"lastname": "<string>",
"notification_app": True,
"notification_email": True,
"notification_interval": "<string>",
"notifications": ["<string>"],
"phone_number": "<string>",
"volume_unit": "<string>",
"temperature_unit": "<string>",
"group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_id": "<string>",
"consent": True,
"google_home": True,
"dark_theme": True,
"use_phone_theme": True,
"automatic_timezone": True,
"routines": ["<string>"],
"locale": "<string>",
"sharing_requests": True,
"updated_at": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
address: {
city: '<string>',
country: '<string>',
street: '<string>',
zip_code: '<string>'
},
company: '<string>',
firstname: '<string>',
lastname: '<string>',
notification_app: true,
notification_email: true,
notification_interval: '<string>',
notifications: ['<string>'],
phone_number: '<string>',
volume_unit: '<string>',
temperature_unit: '<string>',
group_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
customer_id: '<string>',
consent: true,
google_home: true,
dark_theme: true,
use_phone_theme: true,
automatic_timezone: true,
routines: ['<string>'],
locale: '<string>',
sharing_requests: true,
updated_at: '<string>'
})
};

fetch('https://api.orbital-systems.com/client/user', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbital-systems.com/client/user",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'address' => [
'city' => '<string>',
'country' => '<string>',
'street' => '<string>',
'zip_code' => '<string>'
],
'company' => '<string>',
'firstname' => '<string>',
'lastname' => '<string>',
'notification_app' => true,
'notification_email' => true,
'notification_interval' => '<string>',
'notifications' => [
'<string>'
],
'phone_number' => '<string>',
'volume_unit' => '<string>',
'temperature_unit' => '<string>',
'group_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'customer_id' => '<string>',
'consent' => true,
'google_home' => true,
'dark_theme' => true,
'use_phone_theme' => true,
'automatic_timezone' => true,
'routines' => [
'<string>'
],
'locale' => '<string>',
'sharing_requests' => true,
'updated_at' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$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.orbital-systems.com/client/user"

payload := strings.NewReader("{\n \"address\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"zip_code\": \"<string>\"\n },\n \"company\": \"<string>\",\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\",\n \"notification_app\": true,\n \"notification_email\": true,\n \"notification_interval\": \"<string>\",\n \"notifications\": [\n \"<string>\"\n ],\n \"phone_number\": \"<string>\",\n \"volume_unit\": \"<string>\",\n \"temperature_unit\": \"<string>\",\n \"group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"customer_id\": \"<string>\",\n \"consent\": true,\n \"google_home\": true,\n \"dark_theme\": true,\n \"use_phone_theme\": true,\n \"automatic_timezone\": true,\n \"routines\": [\n \"<string>\"\n ],\n \"locale\": \"<string>\",\n \"sharing_requests\": true,\n \"updated_at\": \"<string>\"\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("x-api-key", "<api-key>")
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.put("https://api.orbital-systems.com/client/user")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"address\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"zip_code\": \"<string>\"\n },\n \"company\": \"<string>\",\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\",\n \"notification_app\": true,\n \"notification_email\": true,\n \"notification_interval\": \"<string>\",\n \"notifications\": [\n \"<string>\"\n ],\n \"phone_number\": \"<string>\",\n \"volume_unit\": \"<string>\",\n \"temperature_unit\": \"<string>\",\n \"group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"customer_id\": \"<string>\",\n \"consent\": true,\n \"google_home\": true,\n \"dark_theme\": true,\n \"use_phone_theme\": true,\n \"automatic_timezone\": true,\n \"routines\": [\n \"<string>\"\n ],\n \"locale\": \"<string>\",\n \"sharing_requests\": true,\n \"updated_at\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.orbital-systems.com/client/user")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"address\": {\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"zip_code\": \"<string>\"\n },\n \"company\": \"<string>\",\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\",\n \"notification_app\": true,\n \"notification_email\": true,\n \"notification_interval\": \"<string>\",\n \"notifications\": [\n \"<string>\"\n ],\n \"phone_number\": \"<string>\",\n \"volume_unit\": \"<string>\",\n \"temperature_unit\": \"<string>\",\n \"group_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"customer_id\": \"<string>\",\n \"consent\": true,\n \"google_home\": true,\n \"dark_theme\": true,\n \"use_phone_theme\": true,\n \"automatic_timezone\": true,\n \"routines\": [\n \"<string>\"\n ],\n \"locale\": \"<string>\",\n \"sharing_requests\": true,\n \"updated_at\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "role": "<string>",
  "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "address": {
    "city": "<string>",
    "country": "<string>",
    "street": "<string>",
    "zip_code": "<string>"
  },
  "company": "<string>",
  "email": "<string>",
  "firstname": "<string>",
  "lastname": "<string>",
  "notification_app": true,
  "notification_email": true,
  "notification_interval": "<string>",
  "notifications": [
    "<string>"
  ],
  "phone_number": "<string>",
  "volume_unit": "<string>",
  "temperature_unit": "<string>",
  "customer_id": "<string>",
  "consent": true,
  "google_home": true,
  "dark_theme": true,
  "use_phone_theme": true,
  "routines": [
    "<string>"
  ],
  "updated_at": "<string>",
  "automatic_timezone": true,
  "locale": "<string>",
  "sharing_requests": true
}
{}
{}
{}

Authorizations

x-api-key
string
header
required

Body

application/json
address
object
company
string
firstname
string
lastname
string
notification_app
boolean
notification_email
boolean
notification_interval
string
notifications
string[]
phone_number
string
volume_unit
string
temperature_unit
string
group_id
string<uuid>
customer_id
string
google_home
boolean
dark_theme
boolean
use_phone_theme
boolean
automatic_timezone
boolean
routines
string[]
locale
string
sharing_requests
boolean
updated_at
string

Response

User updated successfully

id
string<uuid>
role
string
group_id
string<uuid>
address
object
company
string
email
string
firstname
string
lastname
string
notification_app
boolean
notification_email
boolean
notification_interval
string
notifications
string[]
phone_number
string
volume_unit
string
temperature_unit
string
customer_id
string
google_home
boolean
dark_theme
boolean
use_phone_theme
boolean
routines
string[]
updated_at
string
automatic_timezone
boolean
locale
string
sharing_requests
boolean