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

# Update profile

> Set a Profile's language (BCP-47) and/or country (ISO 3166-1 alpha-2). Each value is saved as a manual edit, which later imports and integration syncs don't overwrite, and updates the Profile's `language` / `country`. Values can be changed but not cleared. Returns the updated Profile.



## OpenAPI

````yaml /api-reference/openapi.json patch /api/v1/profiles/{profileId}
openapi: 3.0.3
info:
  title: SegmentFlow.ai API
  description: Unified SegmentFlow.ai API documentation
  version: 1.0.0
servers:
  - url: http://localhost:3001
    description: Local development
  - url: https://api-staging.segmentflow.ai
    description: Staging
  - url: https://api.segmentflow.ai
    description: Production
security:
  - apiKeyAuth: []
tags:
  - name: Profiles
    description: Profiles (Contacts)
  - name: Events
    description: Server-side business event tracking
  - name: Assets
    description: Assets
  - name: BackgroundJobs
    description: Background job progress
  - name: Brand-Kit
    description: Brand kits
  - name: Catalog-Products
    description: Catalog products
  - name: Templates
    description: Templates
  - name: Broadcasts
    description: Broadcasts
  - name: Segments
    description: Segments
  - name: Subscription-Groups
    description: Subscription groups
  - name: Privacy-Requests
    description: Privacy requests (GDPR data exports and erasures)
  - name: Journeys
    description: Journeys
  - name: Emails
    description: Email sends
paths:
  /api/v1/profiles/{profileId}:
    patch:
      tags:
        - Profiles
      summary: Update profile
      description: >-
        Set a Profile's language (BCP-47) and/or country (ISO 3166-1 alpha-2).
        Each value is saved as a manual edit, which later imports and
        integration syncs don't overwrite, and updates the Profile's `language`
        / `country`. Values can be changed but not cleared. Returns the updated
        Profile.
      operationId: Profiles_Profiles_Update
      parameters:
        - schema:
            type: string
            minLength: 1
          in: path
          name: profileId
          required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                language:
                  description: >-
                    BCP-47 language tag (en, et-EE). Stored normalized: a bare
                    language gets its default region (en becomes en-US).
                  type: string
                country:
                  description: ISO 3166-1 alpha-2 country code (EE). Stored upper case.
                  type: string
              additionalProperties: false
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Profile'
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded. Wait for `Retry-After` seconds, then retry.
          headers:
            Retry-After:
              schema:
                type: integer
              description: Seconds to wait before retrying.
            X-RateLimit-Limit:
              schema:
                type: integer
              description: Requests allowed in the current window.
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Requests left in the current window.
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Seconds until the current window resets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitedErrorResponse'
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    Profile:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
          description: Canonical email identifier from Profile.email (always present).
        phone:
          nullable: true
          description: Optional phone number from Profile.phone. Non-canonical in v1.
          type: string
        language:
          nullable: true
          description: Canonical customer language preference from Profile.language.
          type: string
        country:
          nullable: true
          description: ISO 3166-1 alpha-2 customer country from Profile.country.
          type: string
        sources:
          type: array
          items:
            type: string
          description: >-
            Distinct segment_membership source tags for this Profile (e.g.
            'form_submission', 'csv_import', 'shopify'). Used as a fallback when
            the Profile has no property assignments tagged with a source.
        properties:
          type: object
          additionalProperties:
            type: object
            properties:
              name:
                type: string
              value:
                description: Any JSON value.
                nullable: true
              source:
                type: string
                enum:
                  - sdk
                  - computed
                  - csv_import
                  - excel_import
                  - tsv_import
                  - unknown
                  - manual_edit
                  - form_submission
                  - api_sync
                  - shopify
                  - woocommerce
                  - wordpress
                  - salesforce
                description: Origin of this property value for data lineage tracking
              platform:
                nullable: true
                description: >-
                  System-of-record platform (shopify | woocommerce | wordpress |
                  salesforce). Null when no platform-of-record applies.
                type: string
              computedAt:
                nullable: true
                description: ISO timestamp of when this property value was last updated
                type: string
            required:
              - name
              - value
              - source
              - platform
              - computedAt
            additionalProperties: false
        segments:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              type:
                type: string
            required:
              - id
              - name
              - type
            additionalProperties: false
        deliverySuppression:
          type: object
          properties:
            suppressed:
              type: boolean
            reason:
              nullable: true
              type: string
              enum:
                - HardBounced
                - Complained
                - SoftBounceSuppressed
                - Unsubscribed
            email:
              type: string
              description: Canonical Profile/email this state applies to.
            suppressedAt:
              nullable: true
              description: ISO timestamp of when the active suppression started.
              type: string
            latestBounceReason:
              description: >-
                Latest SES bounce reason/diagnostic text explaining the active
                delivery suppression, when available.
              nullable: true
              type: string
            latestBounceDiagnosticCode:
              description: >-
                Latest raw SES recipient diagnostic code for the active delivery
                suppression, when available.
              nullable: true
              type: string
          required:
            - suppressed
            - reason
            - email
            - suppressedAt
          additionalProperties: false
        createdAt:
          type: string
          description: ISO timestamp of when this Profile was created
        updatedAt:
          type: string
          description: ISO timestamp of when this Profile was last updated
      required:
        - id
        - email
        - phone
        - language
        - country
        - sources
        - properties
        - segments
        - deliverySuppression
        - createdAt
        - updatedAt
      additionalProperties: false
      description: >-
        Unified API view of a Profile row, with property data-lineage envelope
        and segment memberships.
    ErrorResponse:
      type: object
      properties:
        errorCode:
          description: >-
            Stable machine-readable error code. SDKs map this to typed exception
            classes.
          example: TEMPLATE_NAME_EXISTS
          allOf:
            - $ref: '#/components/schemas/SegmentflowErrorCode'
        message:
          type: string
          description: >-
            Human-readable error message. May change between releases; do not
            parse.
          example: Template name 'Hello' already exists in this organization.
        details:
          description: >-
            Optional structured detail. `issues` carries per-field validation
            problems; other keys are reserved.
          type: object
          properties:
            issues:
              type: array
              items:
                $ref: '#/components/schemas/ErrorIssue'
          additionalProperties:
            description: Any JSON value.
            nullable: true
      required:
        - errorCode
        - message
      additionalProperties: false
      description: 'Canonical error envelope (ADR-0008): `{ errorCode, message, details? }`.'
    RateLimitedErrorResponse:
      type: object
      properties:
        errorCode:
          type: string
          enum:
            - RATE_LIMITED
          description: The request was rejected by an API rate limit.
          example: RATE_LIMITED
        message:
          type: string
          description: >-
            Human-readable error message. May change between releases; do not
            parse.
          example: Rate limit exceeded. Retry after 12 seconds.
        details:
          type: object
          properties:
            retryAfterSeconds:
              type: integer
              minimum: 0
              maximum: 9007199254740991
              description: >-
                Seconds to wait before retrying. Matches the `Retry-After`
                response header.
              example: 12
          required:
            - retryAfterSeconds
          additionalProperties: false
          description: When the client may retry.
      required:
        - errorCode
        - message
        - details
      additionalProperties: false
      description: >-
        429 error envelope (ADR-0008) sent when an API rate limit rejects the
        request.
    SegmentflowErrorCode:
      type: string
      enum:
        - BAD_REQUEST
        - UNAUTHORIZED
        - FORBIDDEN
        - NOT_FOUND
        - CONFLICT
        - GONE
        - UNPROCESSABLE_ENTITY
        - PAYLOAD_TOO_LARGE
        - TOO_MANY_REQUESTS
        - VALIDATION_ERROR
        - RATE_LIMITED
        - INTERNAL_ERROR
        - NOT_IMPLEMENTED
        - SERVICE_UNAVAILABLE
        - DATABASE_ERROR
        - IDEMPOTENCY_KEY_TOO_LONG
        - IDEMPOTENCY_KEY_REUSED
        - IDEMPOTENCY_IN_FLIGHT
        - JOURNEY_NOT_FOUND
        - JOURNEY_WRONG_ENTRY_NODE
        - JOURNEY_MISSING_RECIPIENT_EMAIL
        - JOURNEY_MISSING_REQUIRED_VARIABLES
        - JOURNEY_RECIPIENT_ERASED
        - BROADCAST_NOT_FOUND
        - BROADCAST_SCHEDULING_NOT_IMPLEMENTED
        - BROADCAST_INVALID_STATE
        - BROADCAST_SEND_NOT_ALLOWED
        - PREPARED_SEND_NOT_FOUND
        - PREPARED_SEND_EXPIRED
        - PREPARED_SEND_CROSS_USER
        - PREPARED_SEND_CORRUPT
        - PREPARED_SEND_CONCURRENT_REDEEM
        - PREPARED_SEND_VALIDATION_FAILED
        - SEGMENT_COUNT_CHANGED
        - NAME_TAKEN
        - DRAFT_CHANGED
        - DASHBOARD_EDITOR_REQUIRED
        - TEMPLATE_NOT_FOUND
        - TEMPLATE_NAME_EXISTS
        - TEMPLATE_GROUP_NOT_FOUND
        - TEMPLATE_GROUP_IN_USE
        - PROFILE_NOT_FOUND
        - PROFILE_SUBSCRIPTION_GROUP_NOT_FOUND
        - PROFILE_TRAITS_WRITE_UNSUPPORTED
        - PROFILE_PROPERTY_VALUE_INVALID
        - PROFILE_PROPERTY_NOT_EDITABLE
        - BULK_OPERATION_NOT_UNDOABLE
        - ANALYSIS_ALREADY_USED
        - ANALYSIS_EXPIRED
        - IMPORT_PLAN_INVALID
        - MISSING_CREDENTIAL
        - INVALID_API_KEY
        - INVALID_OAUTH_TOKEN
        - AMBIGUOUS_CREDENTIAL
        - INSUFFICIENT_SCOPE
        - MULTIPLE_CREDENTIALS_PRESENT
        - BEARER_CREDENTIAL_REMOVED
        - SESSION_ROLE_INSUFFICIENT
        - API_KEY_SCOPE_INSUFFICIENT
        - BILLING_DISABLED
        - BILLING_NOT_CONFIGURED
        - EMAIL_NOT_VERIFIED
        - ORGANIZATION_SUSPENDED
        - AI_ALLOWANCE_EXHAUSTED
        - WARMING_REQUIRED
        - WARMING_CAPACITY_EXHAUSTED
        - WARMING_NOT_REQUIRED
      description: >-
        Stable machine-readable error code. SDK codegen maps these to typed
        exception classes.
    ErrorIssue:
      type: object
      properties:
        path:
          anyOf:
            - type: string
            - type: array
              items:
                anyOf:
                  - type: string
                  - type: number
          description: >-
            Where in the request the issue occurred. String for simple paths;
            array for nested paths.
          example: name
        code:
          type: string
          description: >-
            Stable, machine-readable kind of issue (e.g. 'required',
            'invalid_type').
          example: duplicate
        message:
          type: string
          description: Human-readable description of the issue.
          example: Template name already exists in this organization.
      required:
        - path
        - code
        - message
      additionalProperties: false
      description: A single validation issue inside an error response's `details.issues[]`.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Unified API key for server-side SDK and API integrations

````

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