Skip to main content
PATCH
/
customers
/
{customerID}
/
users
/
{userID}
Update Customer User By ID
curl --request PATCH \
  --url https://api.joinworth.com/auth/api/v1/customers/{customerID}/users/{userID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "jsmith@example.com",
  "mobile": "<string>",
  "subrole": {
    "id": "<string>",
    "code": "<string>",
    "label": "<string>"
  }
}
'
import requests

url = "https://api.joinworth.com/auth/api/v1/customers/{customerID}/users/{userID}"

payload = {
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"mobile": "<string>",
"subrole": {
"id": "<string>",
"code": "<string>",
"label": "<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({
first_name: '<string>',
last_name: '<string>',
email: 'jsmith@example.com',
mobile: '<string>',
subrole: {id: '<string>', code: '<string>', label: '<string>'}
})
};

fetch('https://api.joinworth.com/auth/api/v1/customers/{customerID}/users/{userID}', 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.joinworth.com/auth/api/v1/customers/{customerID}/users/{userID}",
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' => '<string>',
'last_name' => '<string>',
'email' => 'jsmith@example.com',
'mobile' => '<string>',
'subrole' => [
'id' => '<string>',
'code' => '<string>',
'label' => '<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 := "https://api.joinworth.com/auth/api/v1/customers/{customerID}/users/{userID}"

payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"mobile\": \"<string>\",\n \"subrole\": {\n \"id\": \"<string>\",\n \"code\": \"<string>\",\n \"label\": \"<string>\"\n }\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.joinworth.com/auth/api/v1/customers/{customerID}/users/{userID}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"mobile\": \"<string>\",\n \"subrole\": {\n \"id\": \"<string>\",\n \"code\": \"<string>\",\n \"label\": \"<string>\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.joinworth.com/auth/api/v1/customers/{customerID}/users/{userID}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"mobile\": \"<string>\",\n \"subrole\": {\n \"id\": \"<string>\",\n \"code\": \"<string>\",\n \"label\": \"<string>\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "message": "User details updated successfully"
}
{
"message": "Error occurred",
"errorCode": "ERR_INTERNAL_SERVER"
}
{
"message": "Unauthorized",
"errorCode": "ERR_UNAUTHORIZED"
}
{
"message": "Forbidden",
"errorCode": "ERR_FORBIDDEN"
}
{
"status": "fail",
"message": "Customer user does not exist",
"errorCode": "INVALID",
"data": {
"errorName": "CustomersApiError"
}
}
{
"message": "Internal Server Error",
"errorCode": "ERR_INTERNAL_SERVER"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerID
string
required
userID
string
required

Body

application/json
first_name
string

First name of the user

last_name
string

Last name of the user

email
string<email>

Email address of the user

mobile
string

Mobile number of the user

subrole
object

Subrole details

status
enum<string>

User status (ACTIVE or INACTIVE)

Available options:
ACTIVE,
INACTIVE

Response

OK

status
string
message
string