Skip to main content
Get Need Category Update For Sale

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.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

SaleStatus, SaleId, ContactId, PersonId

GetNeedCategoryUpdateForSale: Before saving a sale, call this to see if the current changes on the sale should result in a userconfirmation dialog asking to automatically update category on contact or person

SaleStatus
enum<string>
Available options:
Unknown,
Open,
Sold,
Lost,
Stalled,
SaintAll
SaleId
integer<int32>
ContactId
integer<int32>
PersonId
integer<int32>

Response

OK

Carrier for an automated category update setting. Carrier object for AutomatedCategoryUpdate. Services for the AutomatedCategoryUpdate Carrier is available from the List Agent.

Enabled
boolean

Indicates whether the automated category update is enabled for this trigger.

TriggerType
enum<string>

The type of change to trigger the auto update

Available options:
None,
SaleRegistered,
SaleSold,
SaleLost,
LeadStatusChanged
UserConfirmation
boolean

Whether to ask the user for confirmation before applying the autoupdate

DefaultCategory
integer<int32>

The default category id to update to, and the actual new value if no user confirmation is needed

LeadstatusId
integer<int32>

The leadstatus id to match on person, to trigger autoupdate of category

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.