> ## Documentation Index > Fetch the complete documentation index at: https://docs.guile.app/llms.txt > Use this file to discover all available pages before exploring further. # Update a client > Change editable contact or profile fields on a barber's client, such as name, phone, email, or extended preferences like allergies. ## OpenAPI ````yaml /api-reference/Clients/openapi.yaml patch /clients/{clientId} openapi: 3.0.0 info: title: Clients version: 0.1.0 contact: name: Guile Engineering url: https://www.guile.app email: engineering@guile.app license: name: MIT url: https://opensource.org/license/mit description: |- The Clients API provides operations for managing a barber's clients within the Guile platform. servers: - url: https://api.guile.app variables: {} - url: https://guile.fly.dev variables: {} security: [] tags: - name: Groups description: Smart groups and booking rules for clients - name: Notes description: Private notes a barber keeps on a client - name: Clients description: A barber client roster paths: /clients/{clientId}: patch: tags: - Clients summary: Update a client description: >- Change editable contact or profile fields on a barber's client, such as name, phone, email, or extended preferences like allergies. operationId: patchBarberClient parameters: - name: clientId in: path required: true schema: $ref: '#/components/schemas/resourceId' requestBody: required: true content: application/merge-patch+json: schema: $ref: '#/components/schemas/clientPatch' responses: '200': description: |- Ok. The operation succeeded. content: application/json: schema: $ref: '#/components/schemas/client' '400': description: >- Bad Request. The request body, request headers, and/or query parameters are not well-formed. This problem response may have one of the following `type` values: * [https://docs.guile.app/problems/badRequest](https://docs.guile.app/problems/badRequest) content: application/problem+json: schema: $ref: '#/components/schemas/apiProblem' '401': description: >- Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given. This problem response may have one of the following `type` values: * [https://docs.guile.app/problems/unauthorized](https://docs.guile.app/problems/unauthorized) content: application/problem+json: schema: $ref: '#/components/schemas/apiProblem' '403': description: >- Forbidden. The authenticated caller is not authorized to perform the requested operation. This problem response may have one of the following `type` values: * [https://docs.guile.app/problems/forbidden](https://docs.guile.app/problems/forbidden) content: application/problem+json: schema: $ref: '#/components/schemas/apiProblem' '404': description: >- Not Found. There is no such resource at the request URL. This problem response may have one of the following `type` values: * [https://docs.guile.app/problems/notFound](https://docs.guile.app/problems/notFound) content: application/problem+json: schema: $ref: '#/components/schemas/apiProblem' '422': description: >- Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid. This problem response may have one of the following `type` values: * [https://docs.guile.app/problems/unprocessableEntity](https://docs.guile.app/problems/unprocessableEntity) content: application/problem+json: schema: $ref: '#/components/schemas/apiProblem' '429': description: >- Too Many Requests. The client has sent too many requests in a given amount of time. This problem response may have one of the following `type` values: * [https://docs.guile.app/problems/tooManyRequests](https://docs.guile.app/problems/tooManyRequests) headers: Retry-After: required: true description: The number of seconds to wait before retrying the request. schema: type: integer format: uint32 content: application/problem+json: schema: $ref: '#/components/schemas/apiProblem' security: - BearerAuth: [] components: schemas: resourceId: type: string description: >- 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. clientPatch: type: object properties: givenName: type: string nullable: true surname: type: string nullable: true nickname: type: string nullable: true phoneNumber: type: string nullable: true birthDate: type: string allOf: - $ref: '#/components/schemas/date' nullable: true emailAddress: type: string nullable: true profilePhoto_URL: type: string nullable: true allergies: type: array items: type: string nullable: true languages: type: array items: type: string nullable: true hairType: type: string nullable: true description: |- Representation used to patch an existing client using the [JSON Merge Patch](https://datatracker.ietf.org/doc/html/rfc7396) format and processing rules. client: type: object required: - givenName - allergies - languages - id - averageAppointmentCost - averageTipAmount - state - noShowCount - createdAt - updatedAt - appointmentCount - lateCancelationCount properties: givenName: type: string nickname: type: string phoneNumber: type: string birthDate: $ref: '#/components/schemas/date' emailAddress: type: string profilePhoto_URL: type: string surname: type: string description: The client's full surname when the authenticated barber may see it. displayName: type: string description: >- The client name the authenticated barber may display under the customer's surname visibility preference. allergies: type: array items: type: string default: [] languages: type: array items: type: string default: [] hairType: type: string id: $ref: '#/components/schemas/resourceId' profilePhoto: allOf: - $ref: '#/components/schemas/Photos.ProfilePhoto' description: The photo assigned to the client. lastAppointmentAt: type: string format: date-time nextAppointmentAt: type: string format: date-time averageAppointmentCost: $ref: '#/components/schemas/money' averageTipAmount: $ref: '#/components/schemas/money' state: $ref: '#/components/schemas/clientState' noShowCount: type: integer format: uint16 description: The client's no-show appointment count. createdAt: type: string format: date-time description: |- The date-time when this resource was created, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. This is derived and immutable. updatedAt: type: string format: date-time description: |- The date-time when this resource was updated, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. This is derived and immutable. review: $ref: '#/components/schemas/clientReview' appointmentCount: type: integer format: uint16 lateCancelationCount: type: integer format: uint16 apiProblem: type: object required: - type - title - occurredAt - id - status properties: type: allOf: - $ref: '#/components/schemas/uri' description: A URI reference that identifies the problem type. title: type: string maxLength: 120 description: >- A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. occurredAt: type: string format: date-time description: >- The date-time when this problem occurred, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. This is derived and immutable. detail: type: string maxLength: 256 description: >- A human-readable explanation specific to this occurrence of the problem. id: allOf: - $ref: '#/components/schemas/resourceId' description: >- The unique identifier for this problem. This is an immutable opaque string. status: allOf: - $ref: '#/components/schemas/statusCode' description: >- The [HTTP status code](https://datatracker.ietf.org/doc/html/rfc7231#section-6)for this occurrence of the problem. instance: allOf: - $ref: '#/components/schemas/uri' maxLength: 2048 description: >- A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment. attributes: type: object additionalProperties: {} description: >- Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. recovery: allOf: - $ref: '#/components/schemas/clientFailureRecovery' description: The recovery contract for this problem occurrence. problems: type: array items: $ref: '#/components/schemas/problem' maxItems: 128 description: |- Optional root-causes if there are multiple problems in the request or API call processing. description: >- API problem or error response, as per [RFC 9457 application/problem+json](https://tools.ietf.org/html/rfc9457). date: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: >- A date, expressed in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) `date` format. Photos.ProfilePhoto: type: object required: - url properties: url: allOf: - $ref: '#/components/schemas/uri' description: The URL for the full profile image. thumbnailUrl: allOf: - $ref: '#/components/schemas/uri' description: The URL for the optimized profile image preview, if available. description: The image variants returned with a profile. money: type: string pattern: ^-?(0|[1-9][0-9]*)\.[0-9][0-9]$ format: decimal description: >- 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. example: '456.78' clientState: type: string enum: - invited - accepted clientReview: type: object required: - rating - occurredAt - review properties: rating: type: integer format: uint8 occurredAt: type: string format: date-time review: type: string uri: type: string maxLength: 1024 format: uri description: A URI reference to an internal or external resource. statusCode: type: integer format: uint16 minimum: 100 maximum: 599 description: The HTTP status code for a response. clientFailureRecovery: type: object required: - outcome - retry properties: outcome: allOf: - $ref: '#/components/schemas/clientFailureOutcome' description: The known outcome of the request. retry: allOf: - $ref: '#/components/schemas/clientRetryDirective' description: The safe retry action for the request. sessionAction: allOf: - $ref: '#/components/schemas/clientSessionAction' description: The session action required before the request can continue. rateLimit: allOf: - $ref: '#/components/schemas/rateLimit' description: The rate limit state that prevented the request. description: The recovery contract for a failed client request. problem: type: object required: - type - title - occurredAt - id - status properties: type: allOf: - $ref: '#/components/schemas/uri' description: A URI reference that identifies the problem type. title: type: string maxLength: 120 description: >- A short, human-readable summary of the problem type. The title is usually the same for all problems with the same `type`. occurredAt: type: string format: date-time description: >- The date-time when this problem occurred, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. This is derived and immutable. detail: type: string maxLength: 256 description: >- A human-readable explanation specific to this occurrence of the problem. id: allOf: - $ref: '#/components/schemas/resourceId' description: >- The unique identifier for this problem. This is an immutable opaque string. status: allOf: - $ref: '#/components/schemas/statusCode' description: >- The [HTTP status code](https://datatracker.ietf.org/doc/html/rfc7231#section-6)for this occurrence of the problem. instance: allOf: - $ref: '#/components/schemas/uri' maxLength: 2048 description: >- A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment. attributes: type: object additionalProperties: {} description: >- Additional optional attributes related to the problem. This data conforms to the schema associated with the error type. description: >- Standard problem or error response, as per [RFC 9457 application/problem+json](https://tools.ietf.org/html/rfc9457). clientFailureOutcome: type: string enum: - notApplied - unknown description: The known outcome of a failed client request. clientRetryDirective: type: string enum: - doNotRetry - retrySameRequest - retrySameRequestAfterDelay description: The safe retry action for a failed client request. clientSessionAction: type: string enum: - refresh - signIn description: The session action required before a failed request can continue. rateLimit: type: object required: - limit - remaining - resetsAt properties: limit: type: integer format: uint64 description: The maximum number of requests allowed in the active window. remaining: type: integer format: uint64 description: The number of requests remaining in the active window. resetsAt: type: string format: date-time description: >- The date-time when the active window resets, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. description: The rate limit state for the request. securitySchemes: BearerAuth: type: http scheme: Bearer ````