Clients
Update a client
Change editable contact or profile fields on a barber’s client, such as name, phone, email, or extended preferences like allergies.
PATCH
/
clients
/
{clientId}
Update a client
curl --request PATCH \
--url https://api.guile.app/clients/{clientId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/merge-patch+json' \
--data '
{
"givenName": "<string>",
"surname": "<string>",
"nickname": "<string>",
"phoneNumber": "<string>",
"birthDate": "<string>",
"emailAddress": "<string>",
"profilePhoto_URL": "<string>",
"allergies": [
"<string>"
],
"languages": [
"<string>"
],
"hairType": "<string>"
}
'import requests
url = "https://api.guile.app/clients/{clientId}"
payload = {
"givenName": "<string>",
"surname": "<string>",
"nickname": "<string>",
"phoneNumber": "<string>",
"birthDate": "<string>",
"emailAddress": "<string>",
"profilePhoto_URL": "<string>",
"allergies": ["<string>"],
"languages": ["<string>"],
"hairType": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/merge-patch+json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/merge-patch+json'
},
body: JSON.stringify({
givenName: '<string>',
surname: '<string>',
nickname: '<string>',
phoneNumber: '<string>',
birthDate: '<string>',
emailAddress: '<string>',
profilePhoto_URL: '<string>',
allergies: ['<string>'],
languages: ['<string>'],
hairType: '<string>'
})
};
fetch('https://api.guile.app/clients/{clientId}', 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.guile.app/clients/{clientId}",
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([
'givenName' => '<string>',
'surname' => '<string>',
'nickname' => '<string>',
'phoneNumber' => '<string>',
'birthDate' => '<string>',
'emailAddress' => '<string>',
'profilePhoto_URL' => '<string>',
'allergies' => [
'<string>'
],
'languages' => [
'<string>'
],
'hairType' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/merge-patch+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.guile.app/clients/{clientId}"
payload := strings.NewReader("{\n \"givenName\": \"<string>\",\n \"surname\": \"<string>\",\n \"nickname\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"profilePhoto_URL\": \"<string>\",\n \"allergies\": [\n \"<string>\"\n ],\n \"languages\": [\n \"<string>\"\n ],\n \"hairType\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/merge-patch+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.guile.app/clients/{clientId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/merge-patch+json")
.body("{\n \"givenName\": \"<string>\",\n \"surname\": \"<string>\",\n \"nickname\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"profilePhoto_URL\": \"<string>\",\n \"allergies\": [\n \"<string>\"\n ],\n \"languages\": [\n \"<string>\"\n ],\n \"hairType\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.guile.app/clients/{clientId}")
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/merge-patch+json'
request.body = "{\n \"givenName\": \"<string>\",\n \"surname\": \"<string>\",\n \"nickname\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"profilePhoto_URL\": \"<string>\",\n \"allergies\": [\n \"<string>\"\n ],\n \"languages\": [\n \"<string>\"\n ],\n \"hairType\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"givenName": "<string>",
"allergies": [],
"languages": [],
"id": "<string>",
"averageAppointmentCost": "456.78",
"averageTipAmount": "456.78",
"noShowCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"appointmentCount": 123,
"lateCancelationCount": 123,
"nickname": "<string>",
"phoneNumber": "<string>",
"birthDate": "<string>",
"emailAddress": "<string>",
"profilePhoto_URL": "<string>",
"surname": "<string>",
"displayName": "<string>",
"hairType": "<string>",
"profilePhoto": {
"url": "<string>",
"thumbnailUrl": "<string>"
},
"lastAppointmentAt": "2023-11-07T05:31:56Z",
"nextAppointmentAt": "2023-11-07T05:31:56Z",
"review": {
"rating": 123,
"occurredAt": "2023-11-07T05:31:56Z",
"review": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {},
"recovery": {
"rateLimit": {
"limit": 123,
"remaining": 123,
"resetsAt": "2023-11-07T05:31:56Z"
}
},
"problems": [
{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {}
}
]
}{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {},
"recovery": {
"rateLimit": {
"limit": 123,
"remaining": 123,
"resetsAt": "2023-11-07T05:31:56Z"
}
},
"problems": [
{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {}
}
]
}{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {},
"recovery": {
"rateLimit": {
"limit": 123,
"remaining": 123,
"resetsAt": "2023-11-07T05:31:56Z"
}
},
"problems": [
{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {}
}
]
}{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {},
"recovery": {
"rateLimit": {
"limit": 123,
"remaining": 123,
"resetsAt": "2023-11-07T05:31:56Z"
}
},
"problems": [
{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {}
}
]
}{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {},
"recovery": {
"rateLimit": {
"limit": 123,
"remaining": 123,
"resetsAt": "2023-11-07T05:31:56Z"
}
},
"problems": [
{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {}
}
]
}{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {},
"recovery": {
"rateLimit": {
"limit": 123,
"remaining": 123,
"resetsAt": "2023-11-07T05:31:56Z"
}
},
"problems": [
{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {}
}
]
}Path Parameters
The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.
Body
application/merge-patch+json
Representation used to patch an existing client using the JSON Merge Patch format and processing rules.
Response
Ok. The operation succeeded.
The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.
A monetary amount in the lowest denomination for the given currency. The numeric value is represented as a string so that it can be exact with no loss of precision. Values may be positive or negative.
Pattern:
^-?(0|[1-9][0-9]*)\.[0-9][0-9]$Example:
"456.78"
A monetary amount in the lowest denomination for the given currency. The numeric value is represented as a string so that it can be exact with no loss of precision. Values may be positive or negative.
Pattern:
^-?(0|[1-9][0-9]*)\.[0-9][0-9]$Example:
"456.78"
Available options:
invited, accepted The client's no-show appointment count.
The client's full surname when the authenticated barber may see it.
The client name the authenticated barber may display under the customer's surname visibility preference.
The photo assigned to the client.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Update a client
curl --request PATCH \
--url https://api.guile.app/clients/{clientId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/merge-patch+json' \
--data '
{
"givenName": "<string>",
"surname": "<string>",
"nickname": "<string>",
"phoneNumber": "<string>",
"birthDate": "<string>",
"emailAddress": "<string>",
"profilePhoto_URL": "<string>",
"allergies": [
"<string>"
],
"languages": [
"<string>"
],
"hairType": "<string>"
}
'import requests
url = "https://api.guile.app/clients/{clientId}"
payload = {
"givenName": "<string>",
"surname": "<string>",
"nickname": "<string>",
"phoneNumber": "<string>",
"birthDate": "<string>",
"emailAddress": "<string>",
"profilePhoto_URL": "<string>",
"allergies": ["<string>"],
"languages": ["<string>"],
"hairType": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/merge-patch+json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/merge-patch+json'
},
body: JSON.stringify({
givenName: '<string>',
surname: '<string>',
nickname: '<string>',
phoneNumber: '<string>',
birthDate: '<string>',
emailAddress: '<string>',
profilePhoto_URL: '<string>',
allergies: ['<string>'],
languages: ['<string>'],
hairType: '<string>'
})
};
fetch('https://api.guile.app/clients/{clientId}', 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.guile.app/clients/{clientId}",
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([
'givenName' => '<string>',
'surname' => '<string>',
'nickname' => '<string>',
'phoneNumber' => '<string>',
'birthDate' => '<string>',
'emailAddress' => '<string>',
'profilePhoto_URL' => '<string>',
'allergies' => [
'<string>'
],
'languages' => [
'<string>'
],
'hairType' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/merge-patch+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.guile.app/clients/{clientId}"
payload := strings.NewReader("{\n \"givenName\": \"<string>\",\n \"surname\": \"<string>\",\n \"nickname\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"profilePhoto_URL\": \"<string>\",\n \"allergies\": [\n \"<string>\"\n ],\n \"languages\": [\n \"<string>\"\n ],\n \"hairType\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/merge-patch+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.guile.app/clients/{clientId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/merge-patch+json")
.body("{\n \"givenName\": \"<string>\",\n \"surname\": \"<string>\",\n \"nickname\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"profilePhoto_URL\": \"<string>\",\n \"allergies\": [\n \"<string>\"\n ],\n \"languages\": [\n \"<string>\"\n ],\n \"hairType\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.guile.app/clients/{clientId}")
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/merge-patch+json'
request.body = "{\n \"givenName\": \"<string>\",\n \"surname\": \"<string>\",\n \"nickname\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"profilePhoto_URL\": \"<string>\",\n \"allergies\": [\n \"<string>\"\n ],\n \"languages\": [\n \"<string>\"\n ],\n \"hairType\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"givenName": "<string>",
"allergies": [],
"languages": [],
"id": "<string>",
"averageAppointmentCost": "456.78",
"averageTipAmount": "456.78",
"noShowCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"appointmentCount": 123,
"lateCancelationCount": 123,
"nickname": "<string>",
"phoneNumber": "<string>",
"birthDate": "<string>",
"emailAddress": "<string>",
"profilePhoto_URL": "<string>",
"surname": "<string>",
"displayName": "<string>",
"hairType": "<string>",
"profilePhoto": {
"url": "<string>",
"thumbnailUrl": "<string>"
},
"lastAppointmentAt": "2023-11-07T05:31:56Z",
"nextAppointmentAt": "2023-11-07T05:31:56Z",
"review": {
"rating": 123,
"occurredAt": "2023-11-07T05:31:56Z",
"review": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {},
"recovery": {
"rateLimit": {
"limit": 123,
"remaining": 123,
"resetsAt": "2023-11-07T05:31:56Z"
}
},
"problems": [
{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {}
}
]
}{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {},
"recovery": {
"rateLimit": {
"limit": 123,
"remaining": 123,
"resetsAt": "2023-11-07T05:31:56Z"
}
},
"problems": [
{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {}
}
]
}{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {},
"recovery": {
"rateLimit": {
"limit": 123,
"remaining": 123,
"resetsAt": "2023-11-07T05:31:56Z"
}
},
"problems": [
{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {}
}
]
}{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {},
"recovery": {
"rateLimit": {
"limit": 123,
"remaining": 123,
"resetsAt": "2023-11-07T05:31:56Z"
}
},
"problems": [
{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {}
}
]
}{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {},
"recovery": {
"rateLimit": {
"limit": 123,
"remaining": 123,
"resetsAt": "2023-11-07T05:31:56Z"
}
},
"problems": [
{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {}
}
]
}{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {},
"recovery": {
"rateLimit": {
"limit": 123,
"remaining": 123,
"resetsAt": "2023-11-07T05:31:56Z"
}
},
"problems": [
{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"detail": "<string>",
"instance": "<string>",
"attributes": {}
}
]
}