Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

PartnerNetworkRecordConnection

Represents a record shared between Salesforce organizations using Salesforce to Salesforce.

Supported Calls

create(), query()

Special Access Rules

As of Winter ’21 and later, only authenticated internal and external users can access this object.

Fields

Field	Details
ConnectionId	Type reference Properties Create, Filter, Group, Nillable, Sort Description Required. ID of the connection a record is shared with.
EndDate	Type dateTime Properties Filter, Nillable, Sort Description Date that sharing of the record was stopped.
LocalRecordId	Type reference Properties Create, Filter, Group, Sort Description Required. ID of the shared record.
ParentRecordId	Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the parent record of the shared record.
PartnerRecordId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the shared record in the connection's organization.
RelatedRecords	Type string Properties Create, Filter, Nillable, Sort Description A comma-separated list of API names for child records to be shared with a parent record.
SendClosedTasks	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Forwards closed tasks related to the shared record.
SendEmails	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Sends an email notifying the connection's representative that you have forwarded the record to them. Only new recipients of a record will receive a notification email.
SendOpenTasks	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort Description Forwards open tasks related to the shared record.
StartDate	Type dateTime Properties Filter, Nillable, Sort Description Date that the shared record was accepted.
Status	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The status of the shared record. One of the following values: `Active (received)` `Active (sent)` `Connected` `Inactive` `Inactive (converted)` `Inactive (deleted)` `Pending (sent)`

Usage

When you create a PartnerNetworkRecordConnection, you forward a record to a connection.

Attempting to forward a record from an object to which the connection is not subscribed results in an Invalid Partner Network Status error.

Note

When you delete a PartnerNetworkRecordConnection, you stop sharing a record with a connection.

To share a record, use the following fields: LocalRecordID and ConnectionId
To share a child of a parent record, use the following fields: LocalRecordID, ConnectionId, and ParentRecordID
To share a child of a parent record and its child records, use the following fields: LocalRecordID, ConnectionId, ParentRecordID, and RelatedRecords

If the organization does not have Salesforce to Salesforce enabled, the PartnerNetworkRecordConnection object is not available, and you can’t access it using the API.

Object Reference for the Salesforce Platform

PartnerNetworkRecordConnection

Supported Calls

Special Access Rules

Fields

Usage

See Also