--- title: "Messaging File" slug: "messaging-file" updated: 2026-03-20T17:20:54Z published: 2026-03-20T17:20:54Z canonical: "docs.relaynetwork.com/messaging-file" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.relaynetwork.com/llms.txt > Use this file to discover all available pages before exploring further. # Messaging File The Messaging File format is used to trigger a message to one or more Customers or Patients, identified by the ccid field. Each row in the .csv file identifies a single ccid and trigger_id combination. Each row can specify a different trigger_id from a different journey. This file format can be sent via SFTP or Uploaded manually via the File Engine Jobs section in CX Builder. ### **Data File Properties: Messaging** | Property | Data Type | Length | Required | Description | | --- | --- | --- | --- | --- | | ccid | string | 100 | Yes | The unique identifier of the Customer. | | trigger_id | string | 100 | Yes | The unique Trigger identifier that was the originating source of the event. | | asset_id | string | 100 | No | The asset_id can be used to override the default branding on the message. | | input_xxx | string | 100 | No | Input parameters to be used in the experience. Each input parameter is prefixed with "input_" followed by the input parameter name. - Custom input parameters are provided by the Client. - Zero or more input_ parameters can be specified. - Different input_ parameters can be specified on each row in the file. - The maximum length of each input_ parameter is 100 characters. | | client_message_tag | string | 100 | No | An optional, Client created, tag that was provided during the initial messaging/onboarding request. | | lb_name | string | 255 | No | Launched by name. If set, identifies the name of the user that triggered the notification. | | lb_source | string | 255 | No | Launched by source. If set, identifies the source system that triggered the notification. | | powerups__* | string | 100 | No | Power Ups Prefill fields for **Full Name** controls. `<uniqueName>` represents the field name configured on the PowerUps form and is provided by the Relay Account Team. The `*` placeholder represents a required sub-field suffix appended after the unique name. Supported values: `first`, `last`. Example: `powerups_fullName_first`. | | powerups__* | string | 100 | No | Power Ups Prefill fields for **Address** controls. `<uniqueName>` represents the field name configured on the PowerUps form and is provided by the Relay Account Team. The `*` placeholder represents a required sub-field suffix appended after the unique name. Supported values: `line_1`, `line_2`, `city`, `state` `zipcode`. Example: `powerups_Address_city`. | | powerups_ | string | 100 | No | Power Ups Prefill fields used to prepopulate all other supported PowerUps form controls. `<uniqueName>` represents the field name configured on the PowerUps form and is provided by the Relay Account Team. Supported control types and expected value formats include: - **Email** – value must be a valid email address (e.g., `bob.jones@example.com`) - **Text Fields (Textbox / Textarea)** – free-text value (e.g., `Gold`, `Additional comments here`) - **Phone** – numeric value; formatting is validated on submission (e.g., `2155551234`) - **Dropdown** – pass the displayed option value exactly as shown on the form (e.g., `Gold Plan`) - **Radio / Single Choice** – pass the displayed option value exactly as shown on the form (e.g., `Yes`) - **Checkbox / Multiple Choice** – pass one or more displayed option values; multiple values must be separated by `;` with no spaces (e.g., `Email;SMS`) - **Number** – numeric value represented as a string (e.g., `3`) - **Spinner** – numeric value represented as a string (e.g., `2`) - **Scale** – numeric value within the scale range configured on the form (e.g., `1`, `5`) Values must comply with the form control type, allowed values, and validation rules configured on the form. | > [!NOTE] > Important Note for “powerups_” fields > > - All Power Ups Prefill fields must begin with powerups_ > - The uniqueName is case sensitive > - The uniqueName on the Power Ups form cannot contain underscores (_) OR (-) > - Power Ups Prefill fields are optional and do NOT overwrite core Customer/Patient profile data > - Unsupported or invalid PowerUps Prefill fields are silently ignored (no warning or validation error is returned). When this occurs, the affected data will not be prefilled on the form and the end user will be required to enter the information manually. #### Sample File [](https://cdn.us.document360.io/6738087b-455d-402f-b70a-a44a4231547e/Images/Documentation/messaging-with-custom-fields.csv)messaging-with-custom-fields191 Byte[](https://cdn.us.document360.io/6738087b-455d-402f-b70a-a44a4231547e/Images/Documentation/messaging-with-custom-fields.csv) ### Rejection Files A rejection report will be posted for each input file provided to Relay. The report will take on the name of the input file, with "REJECT-" appended to the front of the filename. - Files are posted to the SFTP pickup folder/sub-folder matching the file type. See [File Transmissions](/docs/file-transmissions) - File formats match the input file format with the addition of an Errors column at the beginning of the file that includes the reason a record was rejected #### **Rejection Reasons:** | Error Message | Description | | --- | --- | | Ccid exceeds allowed length (100) | The number of characters provided in this field exceeds the limit for the field | | Ccid contains whitespace | There is whitespace detected in your CCID field and this is not accepted. The whitespace should be removed in order to process the record. Hint: If not immediately visible, check to see if there was a whitespace added to the end of the CCID | | Ccid not provided | There was no value in the CCID field, and this is a required field | | Trigger id exceeds allowed length (100) | The trigger ID is too long Note: The trigger ID can be found in the message builder within CX Builder | | Trigger id not provided | The trigger ID is required but the field is blank | | Asset id exceeds allowed length (100) | The number of characters provided in this field exceeds the limit for the field | | Client message tag exceeds allowed length (100) | The number of characters provided in this field exceeds the limit for the field | | Customer id *ccid* not found | The CCID was not found in Relay. Note: A customer must be onboarded first before you can trigger messages. Check to make sure the account was successfully onboarded in a previous step | | Customer id *ccid* deactivated | The CCID was deactivated | | The journey with journey_id *journey_id* is archived | The trigger ID is valid, but the experience was archived in CX Builder | | No journey found for trigger_id *trigger_id* | The trigger ID provided is not associated with an experience in CX Builder Note: Check that the experience has been created in that environment, case sensitivity, and monitor for any extra spaces in the file or on the trigger ID in CX Builder | | Message must be under 5000 characters in length | Message is too long | | Message contains disallowed html tag | The message contains hidden html tags. Navigate to the experience in CX Builder, re-paste the content into a plain text editor to remove additional html, re-paste into the experience and re-save. | | Duplicate message suppression is active | Duplicate message suppression is based on unique values of CCID, trigger_id, dynamic parameters, and consent_type. When a second message is attempted within 15 minutes of the first message, and all of those values are the same, the message will be suppressed. The suppression is lifted after 15 minutes. This logic will also be triggered if you attempt to send more 10 SMS messages to the same customer in a 10-minute window. | | Missing input parameters: param1, param2, …, paramN | The message being launched has dynamic paramaters, no alternate message is setup, and no dynamic parameters have been provided. Note: Check for case sensitivity, extra spaces, and ensure the naming convention matches | | No notification channels exist for this account | The phone number provided was a non-mobile number and was not added to the account, therefore there are no phone numbers associated with that CCID to trigger a message | | No-consent | The consent for that phone number is “stop” in Relay, so the message cannot be sent | | Channel-deactivated | The phone number was deactivated from that CCID | | internal error | The request timed out. Try re-processing the records |