Skip to main content
Create Default Category Entity

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response

OK

Carrier object for CategoryEntity. Services for the CategoryEntity Carrier is available from the List Agent.

CategoryId
integer<int32>

Primary key

Name
string

Name of the category

CategoryGroup
enum<string>

Enum of the group this category belongs to, static list of 5 groups

Available options:
Unknown,
Customer,
PotentialCustomer,
Partner,
Lost,
Other
Tooltip
string

Tooltip of the category

Rank
integer<int32>

Rank of the category

EnableLeadStatus
boolean

True if the category should enable lead status

CategoryFamilyId
integer<int32>

Optional link to family, for grouping things like multiple kinds of customer category under family 'customer'

Deleted
boolean

true if the category is deleted

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.