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

# Refresh contact profile from channel

> Re-fetches the contact's profile (name, avatar, ...) from the channel API for the given contact inbox, when the channel supports on-demand profile lookup. Returns `{status:"skipped",reason:...}` rather than an error when nothing needed refreshing.



## OpenAPI

````yaml /api-reference/platform-api.json post /v1/contacts/{identifier}/refresh-profile
openapi: 3.1.1
info:
  title: ChatbotX
  version: 0.0.1
servers:
  - url: https://app.chatbotx.io/api
security:
  - bearerAuth: []
  - developerAccessToken: []
  - tokenInSearchParams: []
paths:
  /v1/contacts/{identifier}/refresh-profile:
    post:
      tags:
        - Contacts
      summary: Refresh contact profile from channel
      description: >-
        Re-fetches the contact's profile (name, avatar, ...) from the channel
        API for the given contact inbox, when the channel supports on-demand
        profile lookup. Returns `{status:"skipped",reason:...}` rather than an
        error when nothing needed refreshing.
      operationId: contacts.refreshProfile
      parameters:
        - name: identifier
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            description: >-
              Contact identifier: the numeric contact id, an email address, or a
              phone number.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                contactInboxId:
                  type: string
                  pattern: ^\d+$
                  description: >-
                    Id (numeric string) of the contact's channel inbox
                    connection to refresh from.
              required:
                - contactInboxId
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    properties:
                      status:
                        const: updated
                      contact:
                        type: object
                        properties:
                          id:
                            type: string
                          createdAt:
                            type: string
                            format: date-time
                            x-native-type: date
                          updatedAt:
                            type: string
                            format: date-time
                            x-native-type: date
                          avatar:
                            anyOf:
                              - type: string
                              - type: 'null'
                          phoneNumber:
                            anyOf:
                              - type: string
                              - type: 'null'
                          email:
                            anyOf:
                              - type: string
                              - type: 'null'
                          emailVerified:
                            type: boolean
                          emailOptIn:
                            type: boolean
                          firstName:
                            anyOf:
                              - type: string
                              - type: 'null'
                          lastName:
                            anyOf:
                              - type: string
                              - type: 'null'
                          fullName:
                            anyOf:
                              - type: string
                              - type: 'null'
                          gender:
                            anyOf:
                              - enum:
                                  - male
                                  - female
                                  - unknown
                                type: string
                              - type: 'null'
                          lastReadAt:
                            anyOf:
                              - type: string
                                format: date-time
                                x-native-type: date
                              - type: 'null'
                          ref:
                            anyOf:
                              - type: string
                              - type: 'null'
                          country:
                            anyOf:
                              - type: string
                              - type: 'null'
                          state:
                            anyOf:
                              - type: string
                              - type: 'null'
                          city:
                            anyOf:
                              - type: string
                              - type: 'null'
                          location:
                            anyOf:
                              - anyOf:
                                  - anyOf:
                                      - type: string
                                      - type: number
                                      - type: boolean
                                      - type: 'null'
                                  - type: object
                                    propertyNames:
                                      type: string
                                    additionalProperties: {}
                                  - type: array
                                    items:
                                      anyOf:
                                        - {}
                                        - type: 'null'
                              - type: 'null'
                          locale:
                            anyOf:
                              - type: string
                              - type: 'null'
                          timezone:
                            anyOf:
                              - type: string
                              - type: 'null'
                          subscribedAt:
                            anyOf:
                              - type: string
                                format: date-time
                                x-native-type: date
                              - type: 'null'
                          broadcastSubscribedAt:
                            anyOf:
                              - type: string
                                format: date-time
                                x-native-type: date
                              - type: 'null'
                          blockedAt:
                            anyOf:
                              - type: string
                                format: date-time
                                x-native-type: date
                              - type: 'null'
                          workspaceId:
                            type: string
                        required:
                          - id
                          - createdAt
                          - updatedAt
                          - avatar
                          - phoneNumber
                          - email
                          - emailVerified
                          - emailOptIn
                          - firstName
                          - lastName
                          - fullName
                          - gender
                          - lastReadAt
                          - ref
                          - country
                          - state
                          - city
                          - location
                          - locale
                          - timezone
                          - subscribedAt
                          - broadcastSubscribedAt
                          - blockedAt
                          - workspaceId
                    required:
                      - status
                      - contact
                  - type: object
                    properties:
                      status:
                        const: skipped
                      reason:
                        enum:
                          - profileComplete
                          - coolingDown
                          - channelNotCapable
                        type: string
                    required:
                      - status
                      - reason
                  - type: object
                    properties:
                      status:
                        const: unavailable
                    required:
                      - status
                  - type: object
                    properties:
                      status:
                        const: failed
                    required:
                      - status
        '400':
          description: '400'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: businessError
                      status:
                        const: 400
                      message:
                        type: string
                        default: An error occurred while processing your request
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - $ref: '#/components/schemas/UndefinedError'
        '401':
          description: '401'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: UNAUTHORIZED
                      status:
                        const: 401
                      message:
                        type: string
                        default: Authentication required
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: INVALID_CHATBOT_TOKEN
                      status:
                        const: 401
                      message:
                        type: string
                        default: Invalid or missing workspace API token
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - $ref: '#/components/schemas/UndefinedError'
        '403':
          description: '403'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: FORBIDDEN
                      status:
                        const: 403
                      message:
                        type: string
                        default: You do not have permission to perform this action
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: trialExpired
                      status:
                        const: 403
                      message:
                        type: string
                        default: Trial expired
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: macLimitReached
                      status:
                        const: 403
                      message:
                        type: string
                        default: Monthly active contact limit reached
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - $ref: '#/components/schemas/UndefinedError'
        '404':
          description: '404'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: notFound
                      status:
                        const: 404
                      message:
                        type: string
                        default: Resource not found
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - $ref: '#/components/schemas/UndefinedError'
        '422':
          description: '422'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: invalidRequestData
                      status:
                        const: 422
                      message:
                        type: string
                        default: Input validation failed
                      data:
                        type: object
                        properties:
                          issues:
                            type: array
                            items:
                              type: object
                              properties:
                                message:
                                  type: string
                                path:
                                  type: array
                                  items:
                                    anyOf:
                                      - type: string
                                      - type: number
                                      - type: object
                                        properties:
                                          key:
                                            anyOf:
                                              - type: string
                                              - type: number
                                        required:
                                          - key
                                        additionalProperties: {}
                              required:
                                - message
                              additionalProperties: {}
                        required:
                          - issues
                        additionalProperties: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                      - data
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: validation
                      status:
                        const: 422
                      message:
                        type: string
                        default: Validation error
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - $ref: '#/components/schemas/UndefinedError'
        '429':
          description: '429'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: tooManyRequests
                      status:
                        const: 429
                      message:
                        type: string
                        default: Too many requests
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - $ref: '#/components/schemas/UndefinedError'
        '500':
          description: '500'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: INTERNAL_SERVER_ERROR
                      status:
                        const: 500
                      message:
                        type: string
                        default: An unexpected error occurred
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - $ref: '#/components/schemas/UndefinedError'
components:
  schemas:
    UndefinedError:
      type: object
      properties:
        defined:
          const: false
        code:
          type: string
        status:
          type: number
        message:
          type: string
        data: {}
      required:
        - defined
        - code
        - status
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    developerAccessToken:
      type: http
      scheme: bearer
    tokenInSearchParams:
      type: apiKey
      in: query
      name: token

````