Update User

cURL

curl --request PATCH \
  --url http://localhost:8080/users/{user_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": {
    "city": "Bengaluru",
    "country": "IN",
    "line1": "123, MG Road",
    "pincode": "560001",
    "state": "Karnataka",
    "raw": "<string>",
    "line2": "Flat 4B, Sunrise Apartments"
  },
  "dob": "2000-01-15",
  "email": "<string>",
  "first_name": "<string>",
  "last_name": "<string>"
}
'

import requests

url = "http://localhost:8080/users/{user_id}"

payload = {
    "address": {
        "city": "Bengaluru",
        "country": "IN",
        "line1": "123, MG Road",
        "pincode": "560001",
        "state": "Karnataka",
        "raw": "<string>",
        "line2": "Flat 4B, Sunrise Apartments"
    },
    "dob": "2000-01-15",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    address: {
      city: 'Bengaluru',
      country: 'IN',
      line1: '123, MG Road',
      pincode: '560001',
      state: 'Karnataka',
      raw: '<string>',
      line2: 'Flat 4B, Sunrise Apartments'
    },
    dob: '2000-01-15',
    email: '<string>',
    first_name: '<string>',
    last_name: '<string>'
  })
};

fetch('http://localhost:8080/users/{user_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/users/{user_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([
    'address' => [
        'city' => 'Bengaluru',
        'country' => 'IN',
        'line1' => '123, MG Road',
        'pincode' => '560001',
        'state' => 'Karnataka',
        'raw' => '<string>',
        'line2' => 'Flat 4B, Sunrise Apartments'
    ],
    'dob' => '2000-01-15',
    'email' => '<string>',
    'first_name' => '<string>',
    'last_name' => '<string>'
  ]),
  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 := "http://localhost:8080/users/{user_id}"

	payload := strings.NewReader("{\n  \"address\": {\n    \"city\": \"Bengaluru\",\n    \"country\": \"IN\",\n    \"line1\": \"123, MG Road\",\n    \"pincode\": \"560001\",\n    \"state\": \"Karnataka\",\n    \"raw\": \"<string>\",\n    \"line2\": \"Flat 4B, Sunrise Apartments\"\n  },\n  \"dob\": \"2000-01-15\",\n  \"email\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\"\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("http://localhost:8080/users/{user_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": {\n    \"city\": \"Bengaluru\",\n    \"country\": \"IN\",\n    \"line1\": \"123, MG Road\",\n    \"pincode\": \"560001\",\n    \"state\": \"Karnataka\",\n    \"raw\": \"<string>\",\n    \"line2\": \"Flat 4B, Sunrise Apartments\"\n  },\n  \"dob\": \"2000-01-15\",\n  \"email\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/users/{user_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": {\n    \"city\": \"Bengaluru\",\n    \"country\": \"IN\",\n    \"line1\": \"123, MG Road\",\n    \"pincode\": \"560001\",\n    \"state\": \"Karnataka\",\n    \"raw\": \"<string>\",\n    \"line2\": \"Flat 4B, Sunrise Apartments\"\n  },\n  \"dob\": \"2000-01-15\",\n  \"email\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "created_at": "2026-01-15T12:34:56",
  "last_modified_at": "2026-01-15T12:34:56",
  "phone_country_code": "<string>",
  "phone_number": "<string>",
  "user_id": "012345678901",
  "address": {
    "city": "Bengaluru",
    "country": "IN",
    "line1": "123, MG Road",
    "pincode": "560001",
    "state": "Karnataka",
    "raw": "<string>",
    "line2": "Flat 4B, Sunrise Apartments"
  },
  "dob": "2000-01-15",
  "email": "<string>",
  "first_name": "<string>",
  "last_name": "<string>"
}

PATCH

users

{user_id}

cURL

curl --request PATCH \
  --url http://localhost:8080/users/{user_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": {
    "city": "Bengaluru",
    "country": "IN",
    "line1": "123, MG Road",
    "pincode": "560001",
    "state": "Karnataka",
    "raw": "<string>",
    "line2": "Flat 4B, Sunrise Apartments"
  },
  "dob": "2000-01-15",
  "email": "<string>",
  "first_name": "<string>",
  "last_name": "<string>"
}
'

import requests

url = "http://localhost:8080/users/{user_id}"

payload = {
    "address": {
        "city": "Bengaluru",
        "country": "IN",
        "line1": "123, MG Road",
        "pincode": "560001",
        "state": "Karnataka",
        "raw": "<string>",
        "line2": "Flat 4B, Sunrise Apartments"
    },
    "dob": "2000-01-15",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    address: {
      city: 'Bengaluru',
      country: 'IN',
      line1: '123, MG Road',
      pincode: '560001',
      state: 'Karnataka',
      raw: '<string>',
      line2: 'Flat 4B, Sunrise Apartments'
    },
    dob: '2000-01-15',
    email: '<string>',
    first_name: '<string>',
    last_name: '<string>'
  })
};

fetch('http://localhost:8080/users/{user_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/users/{user_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([
    'address' => [
        'city' => 'Bengaluru',
        'country' => 'IN',
        'line1' => '123, MG Road',
        'pincode' => '560001',
        'state' => 'Karnataka',
        'raw' => '<string>',
        'line2' => 'Flat 4B, Sunrise Apartments'
    ],
    'dob' => '2000-01-15',
    'email' => '<string>',
    'first_name' => '<string>',
    'last_name' => '<string>'
  ]),
  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 := "http://localhost:8080/users/{user_id}"

	payload := strings.NewReader("{\n  \"address\": {\n    \"city\": \"Bengaluru\",\n    \"country\": \"IN\",\n    \"line1\": \"123, MG Road\",\n    \"pincode\": \"560001\",\n    \"state\": \"Karnataka\",\n    \"raw\": \"<string>\",\n    \"line2\": \"Flat 4B, Sunrise Apartments\"\n  },\n  \"dob\": \"2000-01-15\",\n  \"email\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\"\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("http://localhost:8080/users/{user_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": {\n    \"city\": \"Bengaluru\",\n    \"country\": \"IN\",\n    \"line1\": \"123, MG Road\",\n    \"pincode\": \"560001\",\n    \"state\": \"Karnataka\",\n    \"raw\": \"<string>\",\n    \"line2\": \"Flat 4B, Sunrise Apartments\"\n  },\n  \"dob\": \"2000-01-15\",\n  \"email\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/users/{user_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": {\n    \"city\": \"Bengaluru\",\n    \"country\": \"IN\",\n    \"line1\": \"123, MG Road\",\n    \"pincode\": \"560001\",\n    \"state\": \"Karnataka\",\n    \"raw\": \"<string>\",\n    \"line2\": \"Flat 4B, Sunrise Apartments\"\n  },\n  \"dob\": \"2000-01-15\",\n  \"email\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "created_at": "2026-01-15T12:34:56",
  "last_modified_at": "2026-01-15T12:34:56",
  "phone_country_code": "<string>",
  "phone_number": "<string>",
  "user_id": "012345678901",
  "address": {
    "city": "Bengaluru",
    "country": "IN",
    "line1": "123, MG Road",
    "pincode": "560001",
    "state": "Karnataka",
    "raw": "<string>",
    "line2": "Flat 4B, Sunrise Apartments"
  },
  "dob": "2000-01-15",
  "email": "<string>",
  "first_name": "<string>",
  "last_name": "<string>"
}

Authorizations

Authorization

string

header

required

JWT bearer token. App-user tokens are issued by POST /auth/token (the partner backend calls it as its platform service account); admin and dashboard tokens are issued via OIDC login.

Path Parameters

user_id

string

required

User ID

Body

application/json

address

A user-submitted address as captured: either the structured form, a single free-text string, or both (the original text plus whatever was structured from it). #[serde(untagged)] keeps the wire shape natural — a bare object or a bare string — so existing structured clients are unaffected.

raw is Secret because a free-text address is PII (it embeds the same data masked elsewhere as line1 / pincode).

Show child attributes

dob

string | null

Example:

"2000-01-15"

string | null

first_name

string | null

gender

null | enum<string>

User gender.

Available options:

MALE,

FEMALE,

OTHER

last_name

string | null

Response

User updated

created_at

string

required

User creation timestamp.

Example:

"2026-01-15T12:34:56"

last_modified_at

string

required

Last user update timestamp.

Example:

"2026-01-15T12:34:56"

phone_country_code

string

required

phone_number

string

required

status

enum<string>

required

User lifecycle status.

Available options:

ONBOARDING,

ACTIVE,

DEACTIVATED

user_id

string

required

A validated 12-digit numeric user identifier.

Every external entry point validates:

JSON Deserialize runs [UserId::parse] (outer whitespace trimmed, length and digit-only enforced) via #[serde(try_from = "String")].
DB FromSql runs [UserId::parse] on every row read.

Display / Deref<Target = str> / AsRef<str> / Into<String> are derived via derive_more — the inner String is pass-through for every read-only borrow, display, and move-out.

Example:

"012345678901"

address

raw is Secret because a free-text address is PII (it embeds the same data masked elsewhere as line1 / pincode).

Show child attributes

dob

string | null

Date of birth as "YYYY-MM-DD".

Example:

"2000-01-15"

string | null

first_name

string | null

gender

null | enum<string>

User gender.

Available options:

MALE,

FEMALE,

OTHER

last_name

string | null

Get User

Complete Onboarding

API Reference

Try It Out

Authorizations

Path Parameters

Body

Response