DataCrm

Sample shape for DataCrm.

Sample JSON

Copy, edit, paste. Server-set fields (id, created, tenantId, …) are omitted from the example — they’re populated by the server on response.

{
  "code": "EXAMPLE",
  "name": "Example name",
  "domain": "example",
  "address": "example",
  "zipcode": "example",
  "country": "example",
  "contacts": [
    "<data-crm-contact>"
  ],
  "sku": [
    "example"
  ]
}

Fields

Field	Type	Required	Notes
`entity`	string • nullable	Server-set	Set by the server. Read-only on writes.
`code`	string	Required
`name`	string	Required
`domain`	string	Required
`address`	string	Required
`zipcode`	string	Required
`country`	string	Required
`contacts`	array<`DataCrmContact`>	Required
`sku`	array<string>	Optional
`tenantId`	string	Server-set	Set by the server. Read-only on writes.
`id`	string	Server-set	Set by the server. Read-only on writes.
`created`	string (date-time)	Server-set	Set by the server. Read-only on writes.
`createdBy`	string	Server-set	Set by the server. Read-only on writes.
`updated`	string (date-time)	Server-set	Set by the server. Read-only on writes.
`updatedBy`	string	Server-set	Set by the server. Read-only on writes.
`deleted`	boolean	Server-set	Set by the server. Read-only on writes.

Used by

Request body

POST /api/finance/crm
PUT /api/finance/crm

Response body

GET /api/finance/crm/{id}
GET /api/finance/crm

CLI

ekso crm — see the command branches page for available verbs. Body for create / update verbs typically passed via --data @file.json matching the sample JSON above.

ConfigSku

DataCrmContact

Reference

Core

Items

Process

Fields

Constraints & Rules

People & Access

Time & Finance

Knowledge

Mail & Tickets

Operational

Settings

Sample JSON

Fields

Used by

Request body

Response body

CLI

​Sample JSON

​Fields

​Used by

​Request body

​Response body

​CLI

Sample JSON

Fields

Used by

Request body

Response body

CLI