Codat · Schema

Update company request

Unified_API

Properties

Name Type Description
name string Name of company being connected.
description object
tags object
View JSON Schema on GitHub

JSON Schema

codat-companyupdaterequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CompanyUpdateRequest",
  "title": "Update company request",
  "x-internal": true,
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of company being connected.",
      "pattern": "^[A-Za-z0-9\\s\\-',&@.,?!\\s]+$",
      "minLength": 1,
      "example": "Bank of Dave"
    },
    "description": {
      "$ref": "#/components/schemas/CompanyRequestBody/properties/description"
    },
    "tags": {
      "$ref": "#/components/schemas/Company/definitions/companyDetails/properties/tags"
    }
  }
}