Clients
Import clients
Bulk-load a barber’s existing roster from JSON or CSV without sending platform invitations.
Every imported row lands in the new smart group until booking behavior moves them.
Partial failures return per-row problems alongside success and failure counts.
POST
/
barbers
/
{barberId}
/
importedClients
Import clients
curl --request POST \
--url https://api.guile.app/barbers/{barberId}/importedClients \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"clients": [
{
"givenName": "<string>",
"surname": "<string>",
"nickname": "<string>",
"phoneNumber": "<string>",
"birthDate": "<string>",
"emailAddress": "<string>",
"profilePhoto_URL": "<string>"
}
]
}
'import requests
url = "https://api.guile.app/barbers/{barberId}/importedClients"
payload = { "clients": [
{
"givenName": "<string>",
"surname": "<string>",
"nickname": "<string>",
"phoneNumber": "<string>",
"birthDate": "<string>",
"emailAddress": "<string>",
"profilePhoto_URL": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
clients: [
{
givenName: '<string>',
surname: '<string>',
nickname: '<string>',
phoneNumber: '<string>',
birthDate: '<string>',
emailAddress: '<string>',
profilePhoto_URL: '<string>'
}
]
})
};
fetch('https://api.guile.app/barbers/{barberId}/importedClients', 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/barbers/{barberId}/importedClients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'clients' => [
[
'givenName' => '<string>',
'surname' => '<string>',
'nickname' => '<string>',
'phoneNumber' => '<string>',
'birthDate' => '<string>',
'emailAddress' => '<string>',
'profilePhoto_URL' => '<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.guile.app/barbers/{barberId}/importedClients"
payload := strings.NewReader("{\n \"clients\": [\n {\n \"givenName\": \"<string>\",\n \"surname\": \"<string>\",\n \"nickname\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"profilePhoto_URL\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.guile.app/barbers/{barberId}/importedClients")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"clients\": [\n {\n \"givenName\": \"<string>\",\n \"surname\": \"<string>\",\n \"nickname\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"profilePhoto_URL\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.guile.app/barbers/{barberId}/importedClients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clients\": [\n {\n \"givenName\": \"<string>\",\n \"surname\": \"<string>\",\n \"nickname\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"profilePhoto_URL\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"successCount": 1,
"failureCount": 1,
"problems": [
{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"attributes": {
"clientIndex": 123,
"reason": "<string>"
},
"detail": "<string>",
"instance": "<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": {}
}
]
}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/jsontext/csv
Show child attributes
Show child attributes
Response
Ok. The operation succeeded.
The number of clients that were successfully imported.
Required range:
x >= 0The number of clients that failed to import.
Required range:
x >= 0A list of problems that occurred during the import. If there are no problems, this field is not included.
Minimum array length:
1Show child attributes
Show child attributes
Was this page helpful?
⌘I
Import clients
curl --request POST \
--url https://api.guile.app/barbers/{barberId}/importedClients \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"clients": [
{
"givenName": "<string>",
"surname": "<string>",
"nickname": "<string>",
"phoneNumber": "<string>",
"birthDate": "<string>",
"emailAddress": "<string>",
"profilePhoto_URL": "<string>"
}
]
}
'import requests
url = "https://api.guile.app/barbers/{barberId}/importedClients"
payload = { "clients": [
{
"givenName": "<string>",
"surname": "<string>",
"nickname": "<string>",
"phoneNumber": "<string>",
"birthDate": "<string>",
"emailAddress": "<string>",
"profilePhoto_URL": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
clients: [
{
givenName: '<string>',
surname: '<string>',
nickname: '<string>',
phoneNumber: '<string>',
birthDate: '<string>',
emailAddress: '<string>',
profilePhoto_URL: '<string>'
}
]
})
};
fetch('https://api.guile.app/barbers/{barberId}/importedClients', 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/barbers/{barberId}/importedClients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'clients' => [
[
'givenName' => '<string>',
'surname' => '<string>',
'nickname' => '<string>',
'phoneNumber' => '<string>',
'birthDate' => '<string>',
'emailAddress' => '<string>',
'profilePhoto_URL' => '<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.guile.app/barbers/{barberId}/importedClients"
payload := strings.NewReader("{\n \"clients\": [\n {\n \"givenName\": \"<string>\",\n \"surname\": \"<string>\",\n \"nickname\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"profilePhoto_URL\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.guile.app/barbers/{barberId}/importedClients")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"clients\": [\n {\n \"givenName\": \"<string>\",\n \"surname\": \"<string>\",\n \"nickname\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"profilePhoto_URL\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.guile.app/barbers/{barberId}/importedClients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clients\": [\n {\n \"givenName\": \"<string>\",\n \"surname\": \"<string>\",\n \"nickname\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"birthDate\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"profilePhoto_URL\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"successCount": 1,
"failureCount": 1,
"problems": [
{
"type": "<string>",
"title": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": 349,
"attributes": {
"clientIndex": 123,
"reason": "<string>"
},
"detail": "<string>",
"instance": "<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": {}
}
]
}