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

# Update an OAuth client



## OpenAPI

````yaml /api-reference/openapi/datasources-api.json patch /oauth/{id}
openapi: 3.0.0
info:
  title: datasources-api
  version: 0.0.0
  description: |-
    # Errors
    | Error code | Message | HTTP status code | Payload |
    | :--- | :--- | :--- | :--- |
    | number | string | 409 |  |
servers:
  - url: https://api.reelevant.com/v2/datasources/
    description: production
security: []
paths:
  /oauth/{id}:
    patch:
      tags:
        - OAuthClient
      summary: Update an OAuth client
      operationId: update-oauth-client
      parameters:
        - name: id
          in: path
          schema:
            type: string
            pattern: ^[0-9a-fA-F]{24}$
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    method:
                      oneOf:
                        - type: string
                          enum:
                            - GET
                        - type: string
                          enum:
                            - POST
                    mode:
                      allOf:
                        - $ref: '#/components/schemas/AuthenticationMode'
                      default: refresh_token
                    tokenUrl:
                      type: string
                      pattern: ^(https?):\/\/[^\s$.?#].([^\s]|\x20)*$
                      example: https://login.salesforce.com/services/oauth2/token
                    authorizeUrl:
                      type: string
                      pattern: ^(https?):\/\/[^\s$.?#].([^\s]|\x20)*$
                      example: https://login.salesforce.com/services/oauth2/authorize
                    clientId:
                      type: string
                    clientSecret:
                      type: string
                      writeOnly: true
                    scopes:
                      type: array
                      items:
                        type: string
                    customPayload:
                      type: object
                      properties:
                        tokenUrl:
                          type: object
                          properties:
                            query:
                              type: object
                              properties: {}
                              additionalProperties:
                                type: string
                            body:
                              type: object
                              properties: {}
                              additionalProperties:
                                type: string
                            headers:
                              type: object
                              properties: {}
                              additionalProperties:
                                type: string
                          additionalProperties: false
                        authorizeUrl:
                          type: object
                          properties:
                            query:
                              type: object
                              properties: {}
                              additionalProperties:
                                type: string
                            body:
                              type: object
                              properties: {}
                              additionalProperties:
                                type: string
                            headers:
                              type: object
                              properties: {}
                              additionalProperties:
                                type: string
                          additionalProperties: false
                      required:
                        - tokenUrl
                        - authorizeUrl
                      additionalProperties: false
                      example: '{ payload: { query: { access_type: ''offline'' } } }'
                    accessTokenPath:
                      type: string
                    accessTokenHeader:
                      type: string
                      example: x-shopify-access-token
                      default: authorization
                    accessTokenHeaderPrefix:
                      type: string
                      example: google
                    tokenExpiration:
                      type: number
                  additionalProperties: false
                - type: object
                  properties:
                    configuration:
                      type: object
                      properties:
                        method:
                          oneOf:
                            - type: string
                              enum:
                                - GET
                            - type: string
                              enum:
                                - POST
                        mode:
                          allOf:
                            - $ref: '#/components/schemas/AuthenticationMode'
                          default: refresh_token
                        tokenUrl:
                          type: string
                          pattern: ^(https?):\/\/[^\s$.?#].([^\s]|\x20)*$
                          example: https://login.salesforce.com/services/oauth2/token
                        authorizeUrl:
                          type: string
                          pattern: ^(https?):\/\/[^\s$.?#].([^\s]|\x20)*$
                          example: >-
                            https://login.salesforce.com/services/oauth2/authorize
                        clientId:
                          type: string
                        clientSecret:
                          type: string
                          writeOnly: true
                        scopes:
                          type: array
                          items:
                            type: string
                        customPayload:
                          type: object
                          properties:
                            tokenUrl:
                              type: object
                              properties:
                                query:
                                  type: object
                                  properties: {}
                                  additionalProperties:
                                    type: string
                                body:
                                  type: object
                                  properties: {}
                                  additionalProperties:
                                    type: string
                                headers:
                                  type: object
                                  properties: {}
                                  additionalProperties:
                                    type: string
                              additionalProperties: false
                            authorizeUrl:
                              type: object
                              properties:
                                query:
                                  type: object
                                  properties: {}
                                  additionalProperties:
                                    type: string
                                body:
                                  type: object
                                  properties: {}
                                  additionalProperties:
                                    type: string
                                headers:
                                  type: object
                                  properties: {}
                                  additionalProperties:
                                    type: string
                              additionalProperties: false
                          required:
                            - tokenUrl
                            - authorizeUrl
                          additionalProperties: false
                          example: '{ payload: { query: { access_type: ''offline'' } } }'
                        accessTokenPath:
                          type: string
                        accessTokenHeader:
                          type: string
                          example: x-shopify-access-token
                          default: authorization
                        accessTokenHeaderPrefix:
                          type: string
                          example: google
                        tokenExpiration:
                          type: number
                      additionalProperties: false
                  additionalProperties: false
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - success
                    required:
                      - status
                    additionalProperties: false
                  - $ref: '#/components/schemas/InternalResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/InternalResponse_'
                  - type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - fail
                      error_code:
                        type: number
                      code:
                        type: number
                      message:
                        type: string
                      data:
                        oneOf:
                          - type: object
                            properties: {}
                            additionalProperties:
                              $ref: '#/components/schemas/AnyValue'
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              field:
                                type: string
                              datasourceId:
                                type: string
                            required:
                              - field
                              - datasourceId
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              fields:
                                type: array
                                items:
                                  type: string
                            required:
                              - fields
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              err:
                                type: string
                            required:
                              - err
                            additionalProperties: false
                          - type: object
                            properties:
                              protocol:
                                type: string
                            required:
                              - protocol
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              field:
                                type: string
                            required:
                              - field
                            additionalProperties: false
                          - type: object
                            properties:
                              field:
                                type: string
                            required:
                              - field
                            additionalProperties: false
                          - type: object
                            properties:
                              field:
                                type: string
                            required:
                              - field
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              fields:
                                type: array
                                items:
                                  type: string
                            required:
                              - fields
                            additionalProperties: false
                          - type: object
                            properties:
                              type:
                                type: string
                            required:
                              - type
                            additionalProperties: false
                          - type: object
                            properties:
                              field:
                                type: string
                            required:
                              - field
                            additionalProperties: false
                          - type: object
                            properties:
                              name:
                                type: string
                            required:
                              - name
                            additionalProperties: false
                          - type: object
                            properties:
                              textEncoding:
                                type: string
                            required:
                              - textEncoding
                            additionalProperties: false
                          - type: object
                            properties:
                              err:
                                type: string
                              format:
                                oneOf:
                                  - type: string
                                    enum:
                                      - avro
                                  - type: string
                                    enum:
                                      - csv
                                  - type: string
                                    enum:
                                      - json
                                  - type: string
                                    enum:
                                      - ndjson
                                  - type: string
                                    enum:
                                      - parquet
                                  - type: string
                                    enum:
                                      - xlsx
                                  - type: string
                                    enum:
                                      - xml
                              url:
                                type: string
                            required:
                              - err
                              - format
                              - url
                            additionalProperties: false
                          - type: object
                            properties:
                              name:
                                type: string
                            required:
                              - name
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              fields:
                                type: array
                                items:
                                  type: string
                            required:
                              - fields
                            additionalProperties: false
                          - type: object
                            properties:
                              err:
                                type: string
                              url:
                                type: string
                            required:
                              - err
                              - url
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              err:
                                type: string
                            required:
                              - err
                            additionalProperties: false
                          - type: object
                            properties:
                              q:
                                type: string
                              err:
                                type: string
                            required:
                              - q
                              - err
                            additionalProperties: false
                          - type: object
                            properties:
                              err:
                                type: string
                            required:
                              - err
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              workflows:
                                type: array
                                items:
                                  type: string
                              contents:
                                type: array
                                items:
                                  type: string
                            required:
                              - workflows
                              - contents
                            additionalProperties: false
                          - type: object
                            properties:
                              expectedStep:
                                $ref: '#/components/schemas/StepName'
                            required:
                              - expectedStep
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              timeout:
                                type: number
                            required:
                              - timeout
                            additionalProperties: false
                          - type: object
                            properties:
                              message:
                                type: string
                            required:
                              - message
                            additionalProperties: false
                          - type: object
                            properties:
                              ids:
                                type: array
                                items:
                                  type: string
                            required:
                              - ids
                            additionalProperties: false
                          - type: object
                            properties:
                              expectedType:
                                $ref: '#/components/schemas/DatasourceType'
                            required:
                              - expectedType
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                    required:
                      - status
                      - error_code
                      - code
                      - message
                    additionalProperties: false
        '404':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/InternalResponse_'
                  - type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - fail
                      error_code:
                        type: number
                      code:
                        type: number
                      message:
                        type: string
                      data:
                        oneOf:
                          - type: object
                            properties: {}
                            additionalProperties:
                              $ref: '#/components/schemas/AnyValue'
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              field:
                                type: string
                              datasourceId:
                                type: string
                            required:
                              - field
                              - datasourceId
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              fields:
                                type: array
                                items:
                                  type: string
                            required:
                              - fields
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              err:
                                type: string
                            required:
                              - err
                            additionalProperties: false
                          - type: object
                            properties:
                              protocol:
                                type: string
                            required:
                              - protocol
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              field:
                                type: string
                            required:
                              - field
                            additionalProperties: false
                          - type: object
                            properties:
                              field:
                                type: string
                            required:
                              - field
                            additionalProperties: false
                          - type: object
                            properties:
                              field:
                                type: string
                            required:
                              - field
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              fields:
                                type: array
                                items:
                                  type: string
                            required:
                              - fields
                            additionalProperties: false
                          - type: object
                            properties:
                              type:
                                type: string
                            required:
                              - type
                            additionalProperties: false
                          - type: object
                            properties:
                              field:
                                type: string
                            required:
                              - field
                            additionalProperties: false
                          - type: object
                            properties:
                              name:
                                type: string
                            required:
                              - name
                            additionalProperties: false
                          - type: object
                            properties:
                              textEncoding:
                                type: string
                            required:
                              - textEncoding
                            additionalProperties: false
                          - type: object
                            properties:
                              err:
                                type: string
                              format:
                                oneOf:
                                  - type: string
                                    enum:
                                      - avro
                                  - type: string
                                    enum:
                                      - csv
                                  - type: string
                                    enum:
                                      - json
                                  - type: string
                                    enum:
                                      - ndjson
                                  - type: string
                                    enum:
                                      - parquet
                                  - type: string
                                    enum:
                                      - xlsx
                                  - type: string
                                    enum:
                                      - xml
                              url:
                                type: string
                            required:
                              - err
                              - format
                              - url
                            additionalProperties: false
                          - type: object
                            properties:
                              name:
                                type: string
                            required:
                              - name
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              fields:
                                type: array
                                items:
                                  type: string
                            required:
                              - fields
                            additionalProperties: false
                          - type: object
                            properties:
                              err:
                                type: string
                              url:
                                type: string
                            required:
                              - err
                              - url
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              err:
                                type: string
                            required:
                              - err
                            additionalProperties: false
                          - type: object
                            properties:
                              q:
                                type: string
                              err:
                                type: string
                            required:
                              - q
                              - err
                            additionalProperties: false
                          - type: object
                            properties:
                              err:
                                type: string
                            required:
                              - err
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              workflows:
                                type: array
                                items:
                                  type: string
                              contents:
                                type: array
                                items:
                                  type: string
                            required:
                              - workflows
                              - contents
                            additionalProperties: false
                          - type: object
                            properties:
                              expectedStep:
                                $ref: '#/components/schemas/StepName'
                            required:
                              - expectedStep
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              timeout:
                                type: number
                            required:
                              - timeout
                            additionalProperties: false
                          - type: object
                            properties:
                              message:
                                type: string
                            required:
                              - message
                            additionalProperties: false
                          - type: object
                            properties:
                              ids:
                                type: array
                                items:
                                  type: string
                            required:
                              - ids
                            additionalProperties: false
                          - type: object
                            properties:
                              expectedType:
                                $ref: '#/components/schemas/DatasourceType'
                            required:
                              - expectedType
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                    required:
                      - status
                      - error_code
                      - code
                      - message
                    additionalProperties: false
      security:
        - password_auth: []
components:
  schemas:
    AuthenticationMode:
      type: string
      enum:
        - password
        - client_credentials
        - refresh_token
        - access_token
        - custom_payload
        - jwt_bearer
    InternalResponse:
      type: object
      properties:
        program:
          type: string
        version:
          type: string
        datetime:
          type: string
        status:
          type: string
        code:
          type: number
        message:
          type: string
        data:
          type: object
          properties:
            companyId:
              $ref: '#/components/schemas/ObjectId'
            resourceGroupIds:
              type: array
              items:
                $ref: '#/components/schemas/ObjectId'
            versions:
              type: array
              items:
                oneOf:
                  - $ref: '#/components/schemas/ObjectId'
                  - allOf:
                      - $ref: '#/components/schemas/Document'
                      - $ref: '#/components/schemas/DatagraphSchemaVersion'
                      - type: object
                        properties:
                          _id:
                            $ref: '#/components/schemas/ObjectId'
                        required:
                          - _id
                        additionalProperties: false
                      - type: object
                        properties:
                          __v:
                            type: number
                        required:
                          - __v
                        additionalProperties: false
                      - $ref: '#/components/schemas/IObjectWithTypegooseFunction'
            archivedAt:
              type: string
              format: date-time
              nullable: true
              readOnly: true
          required:
            - companyId
            - resourceGroupIds
            - versions
            - archivedAt
          additionalProperties: false
      required:
        - program
        - version
        - datetime
        - status
        - message
        - data
      additionalProperties: false
    InternalResponse_:
      type: object
      properties:
        program:
          type: string
        version:
          type: string
        datetime:
          type: string
        status:
          type: string
        code:
          type: number
        message:
          type: string
        data:
          type: object
          properties: {}
          additionalProperties: false
      required:
        - program
        - version
        - datetime
        - status
        - message
        - data
      additionalProperties: false
    AnyValue:
      description: Can be any value
      nullable: true
    StepName:
      type: string
      enum:
        - configure_name
        - configure_resource_group_ids
        - configure_sources
        - configure_fields
        - configure_field
        - create_oauth_client
        - authorize_oauth_client
        - configure_thresholds
        - configure_api_key
        - patch
        - configure_fetcher
        - validate
        - configure_google_tag_manager
        - configure_reelevant_analytics_script
        - configure_product_datasource_source
        - configure_tracking_datasource_source
        - configure_best_product_query
        - configure_best_product_field
        - configure_bought_together
        - configure_merge_mapping
        - configure_merge_datasource_source
        - configure_merge_datasource_dependency
        - configure_top_attributes
        - configure_destination
        - configure_hierarchy
    DatasourceType:
      type: string
      enum:
        - generic
        - location
        - product
        - analytics
        - crm
        - push
    ObjectId:
      type: string
    Document:
      type: object
      properties: {}
      additionalProperties: false
    DatagraphSchemaVersion:
      $ref: '#/components/schemas/Serialize_DatagraphSchemaVersion'
    IObjectWithTypegooseFunction:
      type: object
      properties: {}
      additionalProperties: false
    Serialize_DatagraphSchemaVersion:
      type: object
      properties:
        companyId:
          $ref: '#/components/schemas/ObjectId'
        state:
          allOf:
            - $ref: '#/components/schemas/DatagraphSchemaVersionState'
          readOnly: true
          description: |-
            The state of the version.
            If state=draft, it means this is the draft version, where
            updates occurs.
            If state=live, it means this is the live version used to render
            the content, it won't be updated again
        definition:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              datasourceId:
                type: string
              description:
                type: string
              indexes:
                type: array
                items:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - Index
                    columns:
                      type: array
                      items:
                        type: string
                    description:
                      type: string
                  required:
                    - type
                    - columns
                  additionalProperties: false
              columns:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    type:
                      oneOf:
                        - type: string
                          enum:
                            - string
                        - type: string
                          enum:
                            - boolean
                        - type: string
                          enum:
                            - date
                        - type: string
                          enum:
                            - text
                        - type: string
                          enum:
                            - integer
                        - type: string
                          enum:
                            - datetime
                        - type: string
                          enum:
                            - decimal
                    description:
                      type: string
                    default:
                      oneOf:
                        - type: string
                        - type: number
                        - type: boolean
                          enum:
                            - 'false'
                        - type: boolean
                          enum:
                            - 'true'
                        - type: string
                          format: date-time
                      nullable: true
                    nullable:
                      type: boolean
                  required:
                    - name
                    - type
                    - nullable
                  additionalProperties: false
              virtualColumns:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    type:
                      oneOf:
                        - type: string
                          enum:
                            - string
                        - type: string
                          enum:
                            - boolean
                        - type: string
                          enum:
                            - date
                        - type: string
                          enum:
                            - text
                        - type: string
                          enum:
                            - integer
                        - type: string
                          enum:
                            - datetime
                        - type: string
                          enum:
                            - decimal
                    query:
                      type: string
                    nullable:
                      type: boolean
                    description:
                      type: string
                  required:
                    - name
                    - type
                    - query
                    - nullable
                  additionalProperties: false
              uniqueKeys:
                type: array
                items:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - UniqueKey
                    columns:
                      type: array
                      items:
                        type: string
                    description:
                      type: string
                  required:
                    - type
                    - columns
                  additionalProperties: false
              relations:
                type: array
                items:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - Relation
                    columns:
                      type: array
                      items:
                        type: string
                    reference:
                      type: object
                      properties:
                        datasourceId:
                          type: string
                        columns:
                          type: array
                          items:
                            type: string
                        table:
                          type: string
                      required:
                        - datasourceId
                        - columns
                        - table
                      additionalProperties: false
                    description:
                      type: string
                  required:
                    - type
                    - columns
                    - reference
                  additionalProperties: false
            required:
              - name
              - datasourceId
              - columns
            additionalProperties: false
      required:
        - companyId
        - state
        - definition
      additionalProperties: false
    DatagraphSchemaVersionState:
      type: string
      enum:
        - draft
        - inactive
        - live
  securitySchemes:
    password_auth:
      type: oauth2
      flows:
        password:
          tokenUrl: https://api.reelevant.com/v1/auth/token
          refreshUrl: https://api.reelevant.com/v1/auth/token
          scopes: {}

````