Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

customer-controller

Create or update Customer (saveCustomer)

Creates or Updates the Customer. When creating customer, platform generates Customer Id as time-based UUID. The newly created Customer Id will be present in the response. Specify existing Customer Id to update the Customer. Referencing non-existing Customer Id will cause 'Not Found' error.Remove 'id', 'tenantId' from the request body example (below) to create new Customer entity.

Available for users with 'TENANT_ADMIN' authority.

post/api/customer

Query parameters

nameConflictPolicy'FAIL' | 'UNIQUIFY'

Optional value of name conflict policy. Possible values: FAIL or UNIQUIFY. If omitted, FAIL policy is applied. FAIL policy implies exception will be thrown if an entity with the same name already exists. UNIQUIFY policy appends a suffix to the entity name, if a name conflict occurs.

uniquifySeparatorstring

Optional value of name suffix separator used by UNIQUIFY policy. By default, underscore separator is used. For example, strategy is UNIQUIFY, separator is '-'; if a name conflict occurs for entity name 'test-name', created entity will have name like 'test-name-7fsh4f'.

uniquifyStrategy'RANDOM' | 'INCREMENTAL'

Optional value of uniquify strategy used by UNIQUIFY policy. Possible values: RANDOM or INCREMENTAL. By default, RANDOM strategy is used, which means random alphanumeric string will be added as a suffix to entity name. INCREMENTAL implies the first possible number starting from 1 will be added as a name suffix. For example, strategy is UNIQUIFY, uniquify strategy is INCREMENTAL; if a name conflict occurs for entity name 'test-name', created entity will have name like 'test-name-1.

Request body

createdTimeinteger

Timestamp of the customer creation, in milliseconds

countrystring

Country

statestring

State

citystring

City

addressstring

Address Line 1

address2string

Address Line 2

zipstring

Zip code

phonestring

Phone number

emailstring required

Email

titlestring required

Title of the customer

versioninteger
namestring

Name of the customer. Read-only, duplicated from title for backward compatibility

{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

Example request

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "CUSTOMER"
  },
  "createdTime": 1609459200000,
  "country": "US",
  "state": "NY",
  "city": "New York",
  "phone": "+1(415)777-7777",
  "email": "example@company.com",
  "title": "Company A",
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "name": "Company A",
  "additionalInfo": {}
}

Response

OK

createdTimeinteger

Timestamp of the customer creation, in milliseconds

countrystring

Country

statestring

State

citystring

City

addressstring

Address Line 1

address2string

Address Line 2

zipstring

Zip code

phonestring

Phone number

emailstring required

Email

titlestring required

Title of the customer

versioninteger
namestring

Name of the customer. Read-only, duplicated from title for backward compatibility

{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "CUSTOMER"
  },
  "createdTime": 1609459200000,
  "country": "US",
  "state": "NY",
  "city": "New York",
  "phone": "+1(415)777-7777",
  "email": "example@company.com",
  "title": "Company A",
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "name": "Company A",
  "additionalInfo": {}
}