Kustomer API
Getting access, Developing, Testing
Back to Kustomer
Create a Company
Creates a new company.
Any one of the following roles is required for this endpoint:
|Legacy Role|Equivalent Permission Set Role| |-----|--------| |org.user.company.write|org.permission.company.create|
Custom Attributes
Custom attributes are optional and allow you to specify custom key value pairs. They follow a convention which allows us to specify the field data type with a name suffix:
Suffix
Numor null Ator null Stror null, length: [ 0 .. 1024 ] characters Txtor null, length: [ 0 .. 1024 ] characters Boolor null Urlor null, format:
Input
type: object
properties:
data:
type: string
example: >-
"{\n \"name\": \"<string>\",\n \"externalId\": \"<string>\",\n
\"avatarUrl\": \"<uri>\",\n \"emails\": [\n {\n
\"email\": \"<email-relaxed>\",\n \"type\":
\"<string>\",\n \"verified\": \"<boolean>\"\n }\n
],\n \"phones\": [\n {\n \"phone\":
\"<phone-number>\",\n \"type\": \"<string>\",\n
\"verified\": \"<boolean>\"\n }\n ],\n \"whatsapps\":
[\n {\n \"phone\": \"<whatsapp-number>\",\n
\"type\": \"<string>\",\n \"verified\": \"<boolean>\"\n
}\n ],\n \"socials\": [\n {\n \"type\":
\"<string>\",\n \"username\": \"<string>\",\n
\"userid\": \"<string>\",\n \"url\": \"<uri>\",\n
\"verified\": \"<boolean>\"\n }\n ],\n \"urls\": [\n
{\n \"url\": \"<url>\",\n \"type\":
\"<string>\"\n }\n ],\n \"domains\": [\n
{\n \"domain\": \"<domain-name>\"\n }\n ],\n
\"locations\": [\n {\n \"type\":
\"<string>\",\n \"name\": \"<string>\",\n
\"address\": \"<string>\",\n \"address2\":
\"<string>\",\n \"address3\": \"<string>\",\n
\"latitude\": \"<number>\",\n \"longitude\":
\"<number>\",\n \"countryCode\": \"<string>\",\n
\"countryName\": \"<string>\",\n \"regionCode\":
\"<string>\",\n \"regionName\": \"<string>\",\n
\"cityName\": \"<string>\",\n \"zipCode\":
\"<string>\",\n \"areaCode\": \"<string>\"\n }\n
],\n \"employeeCount\": \"<number>\",\n \"tags\": [\n
\"<string>\"\n ],\n \"createdAt\": \"<dateTime>\",\n
\"importedAt\": \"<dateTime>\",\n \"rev\": \"<number>\",\n
\"custom\": \"<object>\",\n \"defaultLang\": \"<string>\"\n}"
title: Data
Output
type: object
properties:
data:
type: object
properties:
type:
type: string
id:
type: string
attributes:
type: object
properties:
name:
type: string
createdAt:
type: string
updatedAt:
type: string
modifiedAt:
type: string
tags:
type: string
relationships:
type: object
properties:
org:
type: object
properties:
links:
type: object
properties:
self:
type: string
data:
type: object
properties:
type:
type: string
id:
type: string
createdBy:
type: object
properties:
links:
type: object
properties:
self:
type: string
data:
type: object
properties:
type:
type: string
id:
type: string
modifiedBy:
type: object
properties:
links:
type: object
properties:
self:
type: string
data:
type: object
properties:
type:
type: string
id:
type: string
links:
type: object
properties:
self:
type: string