> ## Documentation Index
> Fetch the complete documentation index at: https://swish.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update the current profile

> Updates profile fields such as about text, notification preferences, and marketing consent



## OpenAPI

````yaml https://swish.app/api/2026-07/.well-known/openapi patch /profiles/profile
openapi: 3.0.0
info:
  title: Swish API
  description: >-
    The Swish API provides endpoints for managing profiles, lists, items,
    subscriptions, notifications, orders, etc. All endpoints require
    authentication using a Bearer token. Responses follow a consistent structure
    with a `data` wrapper for successful responses and standardized error
    formats.
  version: 2026-07
  contact: {}
servers:
  - url: https://swish.app/api/2026-07
security: []
tags: []
paths:
  /profiles/profile:
    patch:
      tags:
        - Profiles
      summary: Update the current profile
      description: >-
        Updates profile fields such as about text, notification preferences, and
        marketing consent
      operationId: ProfileController_updateProfile
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProfile'
      responses:
        '200':
          description: The profile has been updated
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Response'
                  - properties:
                      data:
                        $ref: '#/components/schemas/Profile'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - properties:
                      error:
                        allOf:
                          - $ref: '#/components/schemas/Error'
                          - properties:
                              message:
                                type: string
                                example: Validation failed
                              error:
                                type: string
                                example: Bad Request
                              statusCode:
                                type: number
                                example: 400
                              requestId:
                                type: string
                                example: 123e4567-e89b-12d3-a456-426614174000
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - properties:
                      error:
                        allOf:
                          - $ref: '#/components/schemas/Error'
                          - properties:
                              message:
                                type: string
                                example: Failed to authenticate request
                              error:
                                type: string
                                example: Unauthorized
                              statusCode:
                                type: number
                                example: 401
                              requestId:
                                type: string
                                example: 123e4567-e89b-12d3-a456-426614174000
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - properties:
                      error:
                        allOf:
                          - $ref: '#/components/schemas/Error'
                          - properties:
                              message:
                                type: string
                                example: >-
                                  You do not have permission to access this
                                  resource
                              error:
                                type: string
                                example: Forbidden
                              statusCode:
                                type: number
                                example: 403
                              requestId:
                                type: string
                                example: 123e4567-e89b-12d3-a456-426614174000
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - properties:
                      error:
                        allOf:
                          - $ref: '#/components/schemas/Error'
                          - properties:
                              message:
                                type: string
                                example: The requested resource was not found
                              error:
                                type: string
                                example: Not Found
                              statusCode:
                                type: number
                                example: 404
                              requestId:
                                type: string
                                example: 123e4567-e89b-12d3-a456-426614174000
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - properties:
                      error:
                        allOf:
                          - $ref: '#/components/schemas/Error'
                          - properties:
                              message:
                                type: string
                                example: An unexpected error occurred
                              error:
                                type: string
                                example: Internal Server Error
                              statusCode:
                                type: number
                                example: 500
                              requestId:
                                type: string
                                example: 123e4567-e89b-12d3-a456-426614174000
      security:
        - Swish API key: []
        - bearer: []
components:
  schemas:
    UpdateProfile:
      type: object
      properties:
        firstName:
          type: string
          description: First name
          example: John
        lastName:
          type: string
          description: Last name
          example: Doe
        email:
          type: string
          description: Email address
          example: john@example.com
        phone:
          type: string
          description: Phone number
          example: '+353123456789'
        about:
          type: string
          description: About text (metafield)
          example: About me
        notifications:
          description: Notification preferences (metafield)
          allOf:
            - $ref: '#/components/schemas/NotificationSettings'
        birthdate:
          type: string
          format: date
          description: Birthdate (metafield, ISO 8601 date). Send null to clear.
          example: '1990-01-01'
          nullable: true
        marketingConsent:
          description: Marketing consent preferences
          allOf:
            - $ref: '#/components/schemas/MarketingConsent'
    Response:
      type: object
      properties:
        data:
          type: object
          description: Response data
      required:
        - data
    Profile:
      type: object
      properties:
        id:
          type: string
          description: The customer GID
          example: gid://shopify/Customer/123456789
        displayName:
          type: string
          description: Display name (defaults to customer name from Shopify)
          example: John Doe
        firstName:
          type: string
          description: First name
          example: John
          nullable: true
        lastName:
          type: string
          description: Last name
          example: Doe
          nullable: true
        email:
          type: string
          description: Email address
          example: customer@example.com
          nullable: true
        phone:
          type: string
          description: Phone number
          example: '+353123456789'
          nullable: true
        about:
          type: string
          description: About text
          example: ''
          default: ''
        birthdate:
          type: string
          format: date
          description: Birthdate (ISO 8601 date)
          example: '1990-01-01'
          nullable: true
        defaultAddress:
          description: Default address
          nullable: true
          type: object
          allOf:
            - $ref: '#/components/schemas/Address'
        addresses:
          description: All customer addresses (up to 10)
          default: []
          type: array
          items:
            $ref: '#/components/schemas/Address'
        notifications:
          description: Notification preferences
          allOf:
            - $ref: '#/components/schemas/NotificationSettings'
        marketingConsent:
          description: Marketing consent preferences
          allOf:
            - $ref: '#/components/schemas/MarketingConsent'
      required:
        - id
        - displayName
        - about
        - addresses
        - notifications
        - marketingConsent
    ErrorResponse:
      type: object
      properties:
        error:
          description: Error details
          allOf:
            - $ref: '#/components/schemas/Error'
      required:
        - error
    Error:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Something went wrong
        error:
          type: string
          description: The error type
          example: Not Found
        statusCode:
          type: number
          description: The HTTP status code of the error
          example: 404
        requestId:
          type: string
          description: The ID of the request that caused the error
          example: 123e4567-e89b-12d3-a456-426614174000
      required:
        - message
        - error
        - statusCode
        - requestId
    NotificationSettings:
      type: object
      properties:
        priceDrop:
          type: boolean
          description: Price drop notifications enabled
          example: true
          default: true
        backInStock:
          type: boolean
          description: Back in stock notifications enabled
          example: true
          default: true
        lowInStock:
          type: boolean
          description: Low in stock notifications enabled
          example: true
          default: true
      required:
        - priceDrop
        - backInStock
        - lowInStock
    MarketingConsent:
      type: object
      properties:
        email:
          type: boolean
          description: Email marketing consent
          example: false
          default: false
        phone:
          type: boolean
          description: Phone marketing consent
          example: false
          default: false
    Address:
      type: object
      properties:
        id:
          type: string
          description: Address GID
          example: gid://shopify/MailingAddress/123?model_name=CustomerAddress
        address1:
          type: string
          description: Address line 1
          example: 123 Main St
          nullable: true
        address2:
          type: string
          description: Address line 2
          example: Apt 4
          nullable: true
        city:
          type: string
          description: City
          example: Dublin
          nullable: true
        province:
          type: string
          description: Province/State
          example: Leinster
          nullable: true
        country:
          type: string
          description: Country
          example: Ireland
          nullable: true
        zip:
          type: string
          description: Zip/Postal code
          example: D01 X2Y3
          nullable: true
        phone:
          type: string
          description: Phone number
          example: +353 1 234 5678
          nullable: true
        formattedArea:
          type: string
          description: Formatted area (city, province, country)
          example: Ireland
          nullable: true
      required:
        - id
  securitySchemes:
    Swish API key:
      scheme: Bearer
      bearerFormat: JWT
      type: http
      description: Enter your JWT token

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.