Canopy Account External Fields API

openapi: 3.2.0
info:
  title: Canopy Servicing Core Account External Fields API
  description: 'Canopy allows you to easily manage credit, installment, or other more complex lending programs from a servicing and compliance perspective -

    whether newly launched or migrated from existing systems. using canopy, you can track balances and transactions for each customer of your product, both in real-time and historically.

    You can see how various policy and product changes would impact your customers, and readily generate compliance reports and minimize your risk with all real-time information always on hand.

    Canopy additionally surfaces information around all of your lending activity through its intuitive ui which provides a customer support interface as well as at-a-glance data needed for compliance and insights.

    Simply configure your product`s policies through our create product api endpoint, and then you can immediately begin adding customer accounts and relying on canopy for accurate servicing information.'
  contact:
    name: Canopy Support
    url: https://www.canopyservicing.com/contact
    email: support@canopyservicing.com
  version: 1.0.0
servers:
- url: Contact sales to enable your sandbox
  description: Your private sandbox environment
- url: https://demo-api.us.canopyservicing.com
  description: Demo environment
tags:
- name: Account External Fields
  description: External fields that are created for an Account. These fields are used to store additional information about an account that is not part of the core product data.
paths:
  /core/v1/accounts/{account_id}/external_fields:
    put:
      tags:
      - Account External Fields
      summary: Update external fields for an account
      description: 'Edit account''s external fields


        The body of your request should be in the same format used to provide key value pairs when adding external fields when creating an account.


        [{''key'': ''key 1'', ''value'': ''value 1''}, {''key'': ''key 2'', ''value'': ''value 2''}]


        There are a few important aspects to note:


        1. The data that is sent in the body of the request will fully override any values that were previously assigned to the account''s external fields. If you are intending to only update a single key value, we recommend doing a GET /account call first to retrieve the previous values, updating the relevant portion, and then providing that as your body for the request.


        2. The endpoint will accept any valid JSON object, however, if the key/value structure above is not used, you risk breaking your CanopyOS view for the given account.


        3. Changes to the external fields on an account do not trigger the account_update webhook.'
      operationId: AccountExternalFieldsCBV_put_account_external_fields_core_v1_accounts__account_id__external_fields_put
      security:
      - HTTPBearer: []
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          title: Account Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalFieldsRequestSchema'
              description: External fields to add to the account
      responses:
        '200':
          description: The external fields for the account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalFieldsResponseSchema'
        '400':
          description: Your request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrBadRequestSchema'
        '404':
          description: Entity not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrNotFoundSchema'
        '422':
          description: Your request failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrValidationErrorSchema'
        '500':
          description: A server error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrServerErrorSchema'
components:
  schemas:
    ErrBadRequestSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Your request is invalid.
      type: object
      required:
      - message
      title: ErrBadRequestSchema
    ErrValidationErrorSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Your request failed validation.
      type: object
      required:
      - message
      title: ErrValidationErrorSchema
    ErrNotFoundSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Entity not found.
      type: object
      required:
      - message
      title: ErrNotFoundSchema
    ExternalFieldsResponseSchema:
      properties:
        external_fields:
          anyOf:
          - additionalProperties: true
            type: object
          - items:
              additionalProperties: true
              type: object
            type: array
          - items: {}
            type: array
          title: External Fields
      type: object
      required:
      - external_fields
      title: ExternalFieldsResponseSchema
    ExternalFieldsRequestSchema:
      anyOf:
      - additionalProperties: true
        type: object
      - items:
          additionalProperties: true
          type: object
        type: array
      - items: {}
        type: array
      title: ExternalFieldsRequestSchema
    ErrServerErrorSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - A server error has occurred.
      type: object
      required:
      - message
      title: ErrServerErrorSchema
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer