AiVisitRecommendRequest

Represents the details of a visit recommendation request. This object is available in API version 50.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

AcceptedCount

Type: int
Properties: Create, Filter, Group, Nillable, Sort
Description: Number of recommendations created by this recommendation request that are accepted.

Description

Type: string
Properties: Create, Filter, Group, Nillable, Sort
Description: Description of the visit recommendation request.

EndDate

Type: date
Properties: Create, Filter, Group, Sort
Description: Date until which visit recommendations must be created.

ErrorMessage

Type: textarea
Properties: Create, Nillable
Description: Details of why the visit recommendations weren’t generated.

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed a record related to this record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed this record.

Models

Type: textarea
Properties: Create, Nillable
Description: The machine-learning model that creates the visit recommendations.

Name

Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: Name of the visit recommendation request.

NumberOfVisitsPerDay

Type: int
Properties: Create, Filter, Group, Sort
Description: Number of visits that can be scheduled each day.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: ID of the user associated with this record.

RecommendationCount

Type: int
Properties: Create, Filter, Group, Nillable, Sort
Description: Number of recommendations created for the request.

RecommendationResponse

Type: textarea
Properties: Create, Nillable
Description: JSON data containing the recommendations.

RecommendationStrategyName

Type: string
Properties: Create, Filter, Group, Nillable, Sort
Description: Name of the visit recommendation strategy.

RecordTypeId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: ID of the associated record type.

RejectedCount

Type: int
Properties: Create, Filter, Group, Nillable, Sort
Description: Number of recommendations created by this recommendation request that are rejected.

StartDate

Type: date
Properties: Create, Filter, Group, Sort
Description: Date from which visit recommendations must be created.

Status

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort
Description: Status of the visit recommendation request.
Possible values:
- COMPLETED
- FAILED
- IN_PROGRESS
- QUEUED

VisitSiteList

Type: textarea
Properties: Create
Description: List of locations for which visit recommendations are requested.

VisitSiteType

Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort
Description: The type of location for which visit recommendations are requested.

Possible value is: RetailStore