Skip to main content
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>"
    }
  ]
}
'
{
  "successCount": 1,
  "failureCount": 1,
  "problems": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "invalidClient",
      "title": "<string>",
      "status": 349,
      "occurredAt": "2023-11-07T05:31:56Z",
      "detail": "<string>",
      "instance": "<string>",
      "attributes": {
        "clientIndex": 123,
        "reason": "<string>"
      }
    }
  ]
}

Path Parameters

barberId
string<uuid>
required

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

clients
object[]
required

Response

Ok. The operation succeeded.

successCount
integer<int16>
required

The number of clients that were successfully imported.

Required range: x >= 0
failureCount
integer<int16>
required

The number of clients that failed to import.

Required range: x >= 0
problems
object[]

A list of problems that occurred during the import. If there are no problems, this field is not included.

Minimum array length: 1