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

# Unlock a field on a customer

> Lets newer conversations change this field again. The current value stays until one does.



## OpenAPI

````yaml /api-reference/openapi.documented.json post /v1/customer/{customerProfileId}/attributes/{key}/unlock
openapi: 3.1.0
info:
  title: Roark Analytics API
  description: >-
    The Roark Analytics API gives you access to the same API that powers the
    award winning Roark Analytics platform.
  version: 1.0.0
servers:
  - description: Production
    url: https://api.roark.ai
security:
  - Bearer: []
tags:
  - name: Agent
  - name: Customer
  - name: Agent Endpoint
  - name: Tool
  - name: Phone Number
  - name: Call
  - name: Chat
  - name: Metric
  - name: Metric Policy
  - name: Metric Collection Job
  - name: Customer Flow
  - name: Customer Flow Edge Case
  - name: Simulation
  - name: Simulation Persona
  - name: Simulation Environment
  - name: Simulation Scenario
  - name: Simulation Run Plan
  - name: Simulation Template
  - name: Simulation Audio Clip
  - name: Simulation Run Plan Job
  - name: Simulation Job
  - name: HTTP Request Definition
  - name: Webhook
  - name: Issue
  - name: Autoimprove
  - name: Agent Config
  - name: Knowledge Base
  - name: Calendar Connection
  - name: Config
  - name: Organization Project
  - name: Organization Project Member
  - name: Organization Project API Key
  - name: Organization Config
  - name: CLI Auth
  - name: Me
  - name: Project
  - name: Usage
  - name: Analytics
  - name: Dashboard
  - name: Live Report
  - name: Benchmark
  - name: Health
  - name: Prospect Simulation
  - name: Campaign Credit
paths:
  /v1/customer/{customerProfileId}/attributes/{key}/unlock:
    post:
      tags:
        - Customer
      summary: Unlock a field on a customer
      description: >-
        Lets newer conversations change this field again. The current value
        stays until one does.
      operationId: postV1CustomerByCustomerProfileIdAttributesByKeyUnlock
      parameters:
        - in: path
          name: customerProfileId
          schema:
            type: string
            format: uuid
          required: true
        - in: path
          name: key
          schema:
            type: string
            minLength: 1
            maxLength: 100
          required: true
      responses:
        '200':
          description: Updated customer
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Unique identifier of the customer
                      displayName:
                        type:
                          - string
                          - 'null'
                        description: Null until a name is known, which is common
                      phoneNumberE164:
                        type:
                          - string
                          - 'null'
                      externalId:
                        type:
                          - string
                          - 'null'
                      summary:
                        type:
                          - string
                          - 'null'
                      notes:
                        type:
                          - string
                          - 'null'
                        description: Your team's shared notes. Never sent to the agent.
                      notesUpdatedAt:
                        type:
                          - string
                          - 'null'
                        format: date-time
                      conversationCount:
                        type: integer
                      voiceCount:
                        type: integer
                      chatCount:
                        type: integer
                      talkTimeMs:
                        type: integer
                        description: Voice only. Chat time is not included.
                      firstSeenAt:
                        type:
                          - string
                          - 'null'
                        format: date-time
                      lastSeenAt:
                        type:
                          - string
                          - 'null'
                        format: date-time
                      agentIds:
                        type: array
                        items:
                          type: string
                          format: uuid
                      attributes:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                              minLength: 1
                              maxLength: 100
                            value:
                              type: string
                            source:
                              type: string
                              enum:
                                - LIVE_EXTRACTION
                                - POST_CALL_EXTRACTION
                                - API
                                - USER
                              description: >-
                                Where the current value came from. LIVE and
                                POST_CALL extraction are read from
                                conversations.
                            isLocked:
                              type: boolean
                              description: >-
                                True when newer conversations cannot change this
                                field
                            observedAt:
                              type: string
                              format: date-time
                            evidence:
                              type:
                                - object
                                - 'null'
                              properties:
                                value:
                                  type: string
                                source:
                                  type: string
                                  enum:
                                    - LIVE_EXTRACTION
                                    - POST_CALL_EXTRACTION
                                    - API
                                    - USER
                                quote:
                                  type:
                                    - string
                                    - 'null'
                                  description: >-
                                    The customer's words. Null on a project with
                                    redaction on.
                                offsetMs:
                                  type:
                                    - integer
                                    - 'null'
                                  description: Where in the conversation this was said
                                callId:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                                chatId:
                                  type:
                                    - string
                                    - 'null'
                                  format: uuid
                                observedAt:
                                  type: string
                                  format: date-time
                              required:
                                - value
                                - source
                                - quote
                                - offsetMs
                                - callId
                                - chatId
                                - observedAt
                              description: >-
                                The moment the current value was heard. Null for
                                a value set by a person or the API.
                            blockedValue:
                              type:
                                - string
                                - 'null'
                              description: >-
                                What a newer conversation said while this field
                                was locked
                            history:
                              type: array
                              items:
                                type: object
                                properties:
                                  value:
                                    type: string
                                  source:
                                    type: string
                                    enum:
                                      - LIVE_EXTRACTION
                                      - POST_CALL_EXTRACTION
                                      - API
                                      - USER
                                  quote:
                                    type:
                                      - string
                                      - 'null'
                                    description: >-
                                      The customer's words. Null on a project
                                      with redaction on.
                                  offsetMs:
                                    type:
                                      - integer
                                      - 'null'
                                    description: Where in the conversation this was said
                                  callId:
                                    type:
                                      - string
                                      - 'null'
                                    format: uuid
                                  chatId:
                                    type:
                                      - string
                                      - 'null'
                                    format: uuid
                                  observedAt:
                                    type: string
                                    format: date-time
                                required:
                                  - value
                                  - source
                                  - quote
                                  - offsetMs
                                  - callId
                                  - chatId
                                  - observedAt
                              description: >-
                                Other values this field has held or been
                                offered, newest first
                          required:
                            - key
                            - value
                            - source
                            - isLocked
                            - observedAt
                            - evidence
                            - blockedValue
                            - history
                    required:
                      - id
                      - displayName
                      - phoneNumberE164
                      - externalId
                      - summary
                      - notes
                      - notesUpdatedAt
                      - conversationCount
                      - voiceCount
                      - chatCount
                      - talkTimeMs
                      - firstSeenAt
                      - lastSeenAt
                      - agentIds
                      - attributes
                required:
                  - data
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Not found error
              example:
                type: not_found
                code: resource_not_found
                message: The requested resource could not be found
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Roark from '@roarkanalytics/sdk';

            const client = new Roark({
              bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
            });

            const response = await client.customer.unlockAttribute('x', {
              customerProfileId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
            });

            console.log(response.data);
        - lang: Python
          source: |-
            import os
            from roark_analytics import Roark

            client = Roark(
                bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
            )
            response = client.customer.unlock_attribute(
                "x",
                customer_profile_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            )
            print(response.data)
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          enum:
            - validation
            - authentication
            - forbidden
            - not_found
            - conflict
            - payment_required
            - rate_limit
            - internal
          description: The error type category
          examples:
            - validation
            - authentication
        code:
          type: string
          description: Machine-readable error code identifier
          examples:
            - invalid_parameter
            - missing_required_field
            - unauthorized
        message:
          type: string
          description: Human-readable error message
          examples:
            - The request was invalid
            - Authentication required
        param:
          type: string
          description: The parameter that caused the error (if applicable)
          examples:
            - email
            - user_id
        details:
          description: Additional error context information
      required:
        - type
        - code
        - message
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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