kustomer-client
Preparing search index...
KustomerTypes
UpdateCompanyAttributesData
Type Alias UpdateCompanyAttributesData
type
UpdateCompanyAttributesData
=
{
body
?:
{
avatarUrl
?:
string
|
null
;
custom
?:
{
[
key
:
string
]:
never
}
;
defaultLang
?:
string
|
null
;
deleted
?:
boolean
|
null
;
domains
?:
{
domain
:
string
}
[]
;
emails
?:
{
email
:
string
;
type
?:
"home"
|
"work"
|
"other"
;
verified
?:
boolean
;
}
[]
;
employeeCount
?:
number
;
externalId
?:
string
|
null
;
locations
?:
{
address
?:
string
|
null
;
address2
?:
string
|
null
;
address3
?:
string
|
null
;
areaCode
?:
string
|
null
;
cityName
?:
string
|
null
;
countryCode
?:
string
|
null
;
countryName
?:
string
|
null
;
latitude
?:
number
|
null
;
longitude
?:
number
|
null
;
name
?:
string
|
null
;
regionCode
?:
string
|
null
;
regionName
?:
string
|
null
;
type
?:
"home"
|
"work"
|
"other"
;
zipCode
?:
string
|
null
;
}
[]
;
name
?:
string
;
phones
?:
{
phone
:
string
;
type
?:
"mobile"
|
"home"
|
"work"
|
"fax"
|
"other"
;
verified
?:
boolean
;
}
[]
;
rev
?:
number
;
socials
?:
{
type
:
"twitter"
|
"facebook"
|
"instagram"
|
"linkedin"
|
"pinterest"
;
url
?:
string
;
userid
?:
string
;
username
:
string
;
verified
?:
boolean
;
}
[]
;
tags
?:
string
[]
;
urls
?:
{
type
?:
"website"
|
"blog"
|
"other"
;
url
:
string
}
[]
;
whatsapps
?:
{
phone
:
string
;
type
?:
"mobile"
;
verified
?:
boolean
}
[]
;
}
;
path
:
{
id
:
string
}
;
query
?:
never
;
url
:
"/companies/{id}"
;
}
Index
Properties
body?
path
query?
url
Properties
Optional
body
body
?:
{
avatarUrl
?:
string
|
null
;
custom
?:
{
[
key
:
string
]:
never
}
;
defaultLang
?:
string
|
null
;
deleted
?:
boolean
|
null
;
domains
?:
{
domain
:
string
}
[]
;
emails
?:
{
email
:
string
;
type
?:
"home"
|
"work"
|
"other"
;
verified
?:
boolean
;
}
[]
;
employeeCount
?:
number
;
externalId
?:
string
|
null
;
locations
?:
{
address
?:
string
|
null
;
address2
?:
string
|
null
;
address3
?:
string
|
null
;
areaCode
?:
string
|
null
;
cityName
?:
string
|
null
;
countryCode
?:
string
|
null
;
countryName
?:
string
|
null
;
latitude
?:
number
|
null
;
longitude
?:
number
|
null
;
name
?:
string
|
null
;
regionCode
?:
string
|
null
;
regionName
?:
string
|
null
;
type
?:
"home"
|
"work"
|
"other"
;
zipCode
?:
string
|
null
;
}
[]
;
name
?:
string
;
phones
?:
{
phone
:
string
;
type
?:
"mobile"
|
"home"
|
"work"
|
"fax"
|
"other"
;
verified
?:
boolean
;
}
[]
;
rev
?:
number
;
socials
?:
{
type
:
"twitter"
|
"facebook"
|
"instagram"
|
"linkedin"
|
"pinterest"
;
url
?:
string
;
userid
?:
string
;
username
:
string
;
verified
?:
boolean
;
}
[]
;
tags
?:
string
[]
;
urls
?:
{
type
?:
"website"
|
"blog"
|
"other"
;
url
:
string
}
[]
;
whatsapps
?:
{
phone
:
string
;
type
?:
"mobile"
;
verified
?:
boolean
}
[]
;
}
path
path
:
{
id
:
string
}
Type declaration
id
:
string
Unique ID of the company.
Optional
query
query
?:
never
url
url
:
"/companies/{id}"
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
body
path
query
url
kustomer-client
Loading...
Unique ID of the company.