Survey Link

Survey Link allows you to create custom URLs to collect feedback from your customers. Simply generate a link with the desired parameters and send it through any channel: email, SMS, WhatsApp, QR Code, receipt, etc.

Endpoint

The api_token is your SoluCX instance token. You can find it under Instance Settings in the platform.


How It Works

  1. Build the URL with the desired parameters
  2. Send the link to the customer through the channel of your choice
  3. The customer clicks the link and is directed to the survey
  4. The response is automatically recorded in the platform

Available Parameters

Transaction Identification

Use these parameters when you want to link the survey to an existing transaction.

Transaction Parameters

transaction_idstring
External transaction ID (from your system). Searches the transaction by external integration.
scx_transaction_idnumber
SoluCX internal transaction ID.

Customer Data

If no transaction ID is provided, the system will create a new transaction. For this, customer identification is required.

Customer Parameters

customer_idstring
External customer ID (from your system). Required if name is not provided.
namestring
Customer name. Required if customer_id is not provided.
emailstring
Customer email. Must be a valid email address.
phonestring
Primary phone number. Brazilian format (e.g.: 11999999999).
phone2string
Secondary phone number.
documentstring
Customer CPF or CNPJ.
birth_datestring
Date of birth. ISO format (e.g.: 1990-12-31).

Transaction and Employee Data

Transaction Parameters

amountnumber
Transaction amount (e.g.: 150.00). If not provided, defaults to 0.
store_idstring
External store ID (store, hospital, branch). If it doesn't exist, the system tries to create it using store_name.
store_namestring
Store name. Used to automatically create the store if it doesn't exist.
journeystring
Journey slug. Directs to the correct survey. If omitted, uses the default journey.
form_idstring
Form ID. Required for Flex Survey journey types.
employee_idstring
External employee ID. If it doesn't exist, the system tries to create it using employee_name.
employee_namestring
Employee name. Used to automatically create the employee.
param_{key}string
Custom parameters to enrich the transaction (e.g.: param_orderId, param_serviceChannel). This data is available for analysis, cross-referencing, and clustering within the platform.

Advanced Configuration Parameters

Configuration Parameters

sourcestring
Origin channel. If not provided, uses the journey's default channel or email. Accepted values: email, sms, whatsapp, widget, qrcode, tablet, ura, facebook, gmb, api, employee, push_notification, chatbot, workplace, portals.
scorenumber
Pre-filled rating score (e.g.: 10).
modestring
If set to widget, redirects to the compact version of the survey.
langstring
Survey language (e.g.: pt, en, es).

Usage Examples

When you already have a registered transaction and want to send the survey:

https://survey-link.solucx.com.br/link/{api_token}/?transaction_id=ORD-998877

Automatically creates the customer and transaction with the provided data:

https://survey-link.solucx.com.br/link/{api_token}/?name=Maria&[email protected]&document=12345678900&amount=150&store_id=UN01

Directs to a specific journey and links to the employee:

https://survey-link.solucx.com.br/link/{api_token}/?name=Customer&journey=post-sale&employee_name=Carlos

When you have the internal transaction ID in SoluCX:

https://survey-link.solucx.com.br/link/{api_token}/?scx_transaction_id=105543

Enriches the transaction with additional data for analysis and cross-referencing:

https://survey-link.solucx.com.br/link/{api_token}/?name=John&param_orderNumber=1234&param_serviceChannel=App

Example combining customer, transaction, employee, and custom parameters:

https://survey-link.solucx.com.br/link/{api_token}/?name=Maria%20Silva&[email protected]&phone=11999998888&amount=299.90&store_id=ST-001&employee_name=Seller%20John&journey=post-sale&param_paymentMethod=Card&param_installments=3

For Flex Survey journey types that require a form:

https://survey-link.solucx.com.br/link/{api_token}/?name=Customer&form_id=42&journey=satisfaction-survey

Real-World Applications and Use Cases

Generic QR Code (Counter or Restroom)

Ideal for physical locations where you want to capture spontaneous feedback without individually identifying the customer.

Scenario: A QR Code sticker on a shopping mall restroom mirror or a bank branch service counter. A static link is created with a generic name.

Example URL:

https://survey-link.solucx.com.br/link/{api_token}/?name=Visitor&store_id=MallSouth&source=qrcode&journey=restroom-cleaning

Result: The system creates a transaction for the customer "Visitor" linked to the "MallSouth" store in the cleaning journey.


Post-Service Link (WhatsApp/Chat)

Used to close a human service interaction, where the agent sends the link to evaluate the interaction.

Scenario: At the end of a WhatsApp support session, the agent pastes a link. The service system (CRM/Chatbot) generates the link by injecting the customer name and agent name.

Example URL:

https://survey-link.solucx.com.br/link/{api_token}/?name=Ana&employee_name=AgentJohn&source=whatsapp&journey=tech-support

Receipt (Dynamic Printing)

The most data-rich case, where each sale generates a unique link printed at the bottom of the receipt.

Scenario: The customer receives the receipt with a QR Code and a call to action: "Scan and rate your $150.00 purchase at the Downtown store." The POS system (ERP) dynamically generates the link for each sale.

Example URL:

https://survey-link.solucx.com.br/link/{api_token}/?name=Consumer&amount=150.00&store_id=ST-DOWNTOWN&param_pos=POS03&param_nsu=888999&source=qrcode

Advantage: Allows you to track exactly which register (POS), which store, and which sale amount generated the review, cross-referencing financial data with NPS.


Email Signature

To continuously collect relationship feedback through corporate email exchanges.

Scenario: Footer of an account manager's email. A fixed link in the email signature.

Example URL:

https://survey-link.solucx.com.br/link/{api_token}/?name=Partner&employee_name=ManagerRobert&journey=b2b-relationship&source=email

Self-Service Kiosk

To capture feedback at self-service kiosks in stores, airports, or hospitals.

Scenario: After the customer completes an operation at the kiosk (check-in, payment, inquiry), the system displays a QR Code for evaluation.

Example URL:

https://survey-link.solucx.com.br/link/{api_token}/?name=User&store_id=AIRPORT-GRU&source=tablet&journey=self-service&param_operationType=checkin&param_kioskId=K05

Notes

  • The link can be sent through any channel: email, SMS, WhatsApp, QR Code, etc.
  • There is no authentication via header, only via token in the URL.
  • If the store or employee doesn't exist, the system tries to create them automatically using store_name or employee_name.
  • Invalid parameters (such as malformed email or phone outside the standard format) return HTTP 400 error.