RelayConsentAction
- 13 Nov 2024
- 2 Minutes to read
- Print
- DarkLight
RelayConsentAction
- Updated on 13 Nov 2024
- 2 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
WARNING
This action makes an external callout to Relay Network. Please be aware of any impacts this has against your Salesforce API limits. Salesforce Callout Limits
IMPORTANT
It is very important that any user change to TCPA consent is sent to Relay. This ensures Relay will not send messages in violation of TCPA laws.
The Relay Consent Flow Action is used send TCPA consent changes to the Relay platform. This is a very simply action with just two required input values; the mobile phone number and the new consent value associated with it.
An important aspect of TCPA consent is that consent is to the mobile phone number and not an individual user. This means a user could have multiple mobile phone numbers with allowed consent on one number and denied consent on another.
CAUTION
When you send a consent change to Relay, the Relay platform after processing the change will emit a RelayEvent__c record back to Salesforce with the noted change. This can be used as a confirmation that the consent value was in fact received and processed by Relay. However, if you also have a Flow handling consent changes originating from Relay (such as when a user texts in the word stop) you want to be careful and not create an endless loop of consent changes. Therefore, you should only send changes to Relay when the Salesforce field consent field did in fact change. When processing inbound Relay consent changes, you should only update your Salesforce record if the consent value is different from the value currently stored in the record.
RelayConsentAction Input Values
Field | Description |
|---|---|
Send via future | Optional. The Send via future flow action input instructs the Relay action on how to make the callout. If set to True, the action will make the callout in an apex future. If set to False, the action will make the callout in the normal path. If the action is already running as a scheduled flow, or in the asynchronous branch of the flow, you are technically already running in a future so you can always pass in a value of False. Leveraging a future is useful to prevent delays in processing of the flow's primary logic. Valid values are:
|
Relay Client Id | Optional. |
Batch Consent | Optional. Allows sending a batch of consent changes to Relay. From a Salesforce perspective, this is the most efficient option when making a large number of consent changes as it will drastically reduce the number of callout to Relay. If this input is set, it must be a resource apex variable of type RelayConsent. |
Mobile Phone | Required unless a Batch Consent input is provided. Specifies the mobile number associated with the TCPA consent change. |
New Consent | Required unless a Batch Consent input is provided. Specifies the new TCPA consent value associated with the Mobile Phone input field. |
Was this article helpful?