Newer Version Available

This content describes an older version of this product. View Latest

OwnerChangeOptions

Represents actions that can be performed when a record’s owner is changed. Available with these options in API version 35.0 and later.

API Calls

update(), upsert()

Fields

Element Name Type Description
options OwnerChangeOption[]

Represents a flag for a specific action performed when changing a record owner through an update or upsert call.

OwnerChangeOption Fields

Element Name Type Description
execute boolean

If true, the action represented by the type field is performed. If false, the action represented by the type field is skipped.

type enum of a string

Represents the action performed or skipped, according to the given value for the execute field, when changing a record owner during an update or upsert call. The following types can be used.

EnforceNewOwnerHasReadAccess
If true, the record’s new owner must have at least read access on the record. Available in API version 36.0 and later.
KeepAccountTeam
If true, the account team is kept with the account when the account owner is changed. If false, the account team is deleted. Default is false. Available for accounts in API version 45.0 and later.
KeepSalesTeam
If true, the opportunity team is kept with the opportunity when the account owner is changed. If false, the opportunity team is deleted. Default is false. Available for opportunities in API version 45.0 and later.
KeepSalesTeamGrantCurrentOwnerReadWriteAccess
If true, the opportunity’s previous owner retains read/write access after the owner is changed. Default is false. Can be true only when KeepSalesTeam is true. Available for opportunities in API version 44.0 and later.
SendEmail
If true, an email notification is sent to the new owner. Default is false.
TransferAllOwnedCases
If true, all cases (open and closed) owned by the account owner are transferred to the new owner. Default is false. When TransferAllOwnedCases is true, TransferOwnedOpenCases must also be true. Available for accounts in API version 45.0 and later.
TransferArticleOwnedPublishedVersion
If true and the record is a Knowledge article, the article owner's published version for the language of the current draft is transferred to the new owner, in addition to the current draft.
TransferArticleOwnedArchivedVersions
If true and the record is a Knowledge article, the article owner's archived versions for the language of the current draft are transferred to the new owner, in addition to the current draft.
TransferArticleAllVersions
If true and the record is a Knowledge article, all published and archived versions owned by anyone for the language of the current draft are transferred to the new owner, in addition to the current draft.
TransferContacts
If true and the record is a business account, contacts associated with the account are transferred to the new owner.
TransferContracts
If true and the record is an account, contracts associated with the account and owned by the account owner are transferred to the new owner.
TransferNotesAndAttachments
If true, the record’s notes, attachments, and Google Docs are transferred to the new record owner. If false, the original record owner retains ownership.
TransferOpenActivities
If true, the record’s open activities are transferred to the new owner.
TransferOrders
If true and the record is an account, the draft standalone orders associated with the account and draft orders associated with transferred contracts owned by the account owner are transferred to the new owner.
TransferOtherOpenOpportunities
If true and the record is an account, open opportunities associated with the account and not owned by the current owner are transferred to the new owner. When this option is executed, TransferOwnedOpenOpportunities must be set to execute. Default is false.
TransferOwnedClosedOpportunities
If true and the record is an account, closed opportunities owned by the account owner are transferred to the new owner. Default is false. Available for API version 45.0 and later.
TransferOwnedOpenCases
If true and the record is an account, open cases owned by the account owner are transferred to the new owner. Default is false. Available for API version 45.0 and later.
TransferOwnedOpenOpportunities
If true and the record is an account, open opportunities associated with the account and owned by the account owner are transferred to the new owner.

Sample Code—Java

This sample creates an account, a note, an opportunity, and task for the account. It sets the owner change options so that the note, opportunity, and task are transferred to the new owner along with the account.