Merge · Schema

PatchedAccountRequest

# The Account Object ### Description The `Account` object is used to represent a company in a CRM system. ### Usage Example TODO

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name Type Description
owner stringnull The account's owner.
name stringnull The account's name.
description stringnull The account's description.
industry stringnull The account's industry.
website stringnull The account's website.
number_of_employees integernull The account's number of employees.
addresses array
last_activity_at stringnull The last date (either most recent or furthest in the future) of when an activity occurs in an account.
account_url stringnull The account's URL in the remote system.
integration_params objectnull
linked_account_params objectnull
remote_fields array
View JSON Schema on GitHub

JSON Schema

merge-patchedaccountrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PatchedAccountRequest",
  "title": "PatchedAccountRequest",
  "type": "object",
  "properties": {
    "owner": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The account's owner."
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The account's name."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "The account's description."
    },
    "industry": {
      "type": [
        "string",
        "null"
      ],
      "description": "The account's industry."
    },
    "website": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "The account's website."
    },
    "number_of_employees": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The account's number of employees."
    },
    "addresses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AddressRequest"
      }
    },
    "last_activity_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "The last date (either most recent or furthest in the future) of when an activity occurs in an account."
    },
    "account_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "The account's URL in the remote system."
    },
    "integration_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "linked_account_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "remote_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RemoteFieldRequest"
      }
    }
  },
  "description": "# The Account Object\n### Description\nThe `Account` object is used to represent a company in a CRM system.\n### Usage Example\nTODO"
}