- 05 Sep 2025
- 2 Minutes to read
- Print
- DarkLight
Relay Pull PDF Action
- Updated on 05 Sep 2025
- 2 Minutes to read
- Print
- DarkLight
The RelayPullPDFAction is used to pull a PDF document generated from a Relay Power-up form submission. Once downloaded, a ContentDocument link to the specified linkedEntityId will be created.
This flow action is always executed in a background job. If an error occurs during the PDF download, a record will be created in the RelayLog__c custom object.
Action Dialog
Action Input Values
Field | Description |
---|---|
Client Id | Optional. This value is only required when your org is configured to support multiple Relay Client IDs. See: Custom Metadata |
Description | A description for the ContentDocument |
Document Link Share Type | The permission granted to the user of the shared file in a library. This is determined by the permission the user already has in the library. If this field is not provided, then the value of V will be used. Valid values are:
See Salesforce docs: ContentDocumentLink |
Document Link Visibility | Specifies whether this file is available to all users, internal users, or shared users. If this field is not provided, then the default value of AllUsers will be used. Valid values are:
See Salesforce docs: ContentDocumentLink |
Linked Entity Id | Optional. If the Should Create Document field is set to {!$GlobalConstant.True}, then this field must also be provided. This field identifies the Salesforce entity (record) that should be liked to the ContentDocument. For example, this could be the Id field of a Person Account object. See Salesforce docs: ContentDocumentLink |
Should Create Document | Specifies if the action should create a ContentDocument and ContentDocumentLink to the entity identified by the value in the Linked Entity Id field. If this field value is not provided then a default value of {!$GlobalConstant.False} will be used. Valid values are:
|
Submission ID | Required. The Relay Power-up form submission ID. This identifies the PDF that should be downloaded. |
Title | A title for the ContentDocument. |
Action Response Variable
The action returns a custom Relay object RelayPullPDFAction.PullPDFResponse.
Field | Description |
---|---|
statusCode | A numeric value.
|
statusMessage | A human readable message describing the result of the action. |