Skip to main content
Question

locale query parameter ignored on Embedded Sender View (createSenderView)

  • February 18, 2026
  • 3 replies
  • 114 views

Forum|alt.badge.img+1

We're using the EnvelopeViews: createSender endpoint to embed the tagger/sender view in our application. We need to control the display language of the embedded sender view based on the user's account language.

Following the documentation, we append the locale query parameter to the URL returned by the API: https://app.docusign.com/...?locale=de

This approach works correctly for the recipient view (createRecipientView) — the signing UI displays in the expected language.

However, for the sender view (createSenderView), the locale parameter appears to be ignored entirely. The UI always displays in English regardless of the locale value.

Our setup:

  • Using the new API format with EnvelopeViewRequest (settings object with startingScreen: "Tagger", sendButtonAction: "redirect", etc.)
  • The locale parameter is appended as a query parameter to the returned URL (e.g., &locale=de)
  • Tested with multiple locale values (de, fr, etc.) — none take effect

What we've verified:

  • The URL does contain the correct locale parameter
  • The same approach works for createRecipientView

 

Question: Is the locale query parameter supported for the embedded sender view? If not, what is the recommended way to control the display language of the embedded sender/tagger view?

3 replies

Leandro.Reis
Docusign Employee
Forum|alt.badge.img+3
  • Docusign Employee
  • February 20, 2026

Hi ​@Yaugen,

I hope this message finds you well.

Yes — the embedded sender/tagger view does support the locale query parameter in the new EnvelopeViews APIs. The docs explicitly call out a single exception to the “don’t modify the returned URL” rule: you can still append locale to the returned URL for sender/correct views, e.g., …&locale=de or …&locale=fr_CA.

What to do:

  • Append only locale to the returned sender view URL; keep all other UX controls in the request’s settings (startingScreen, sendButtonAction, etc.).
  • Use valid locale codes (language or language_region), e.g., de, fr, fr_CA. The recipient view documents the same mechanism and precedence; the sender/correct views follow the same locale-append exception.
  • Ensure you’re using the new format (EnvelopeViewRequest with viewAccess="envelope") and redeem the one-time URL within its short TTL.

If it still renders English:

  • Verify you are not altering any other query parameters on the returned URL; with the new API, every UX change must be in settings, not in the URL (locale is the only exception).
  • Try a region-specific code (e.g., fr_CA vs fr) and test on both demo and prod to rule out environment differences.
  • As a fallback, confirm the Docusign user’s profile language; the sender view will inherit the user/account language when locale isn’t applied. (Recipient precedence is documented, and sender follows the documented locale exception.)
  • If none of the above works, it’s likely a product issue. Please capture a fresh, single-use sender view URL (with &locale=xx), environment, timestamp, and your request body (returnUrl, viewAccess, settings), and we’ll escalate with engineering.

The language for the recipient view follows this order or precedence:

  • The language specified by the sender for the recipient.
  • The locale parameter appended to the URL.
  • The account language if the signer has a Docusign account.
  • The language used in a previous signing if the signer is return signer.
  • The browser language.

For example, to set the default language to Canadian French, you would add this query parameter to the returned URL:

...&locale=fr_CA

References:

Regards,

Leandro Reis
Developer Support Engineer


Forum|alt.badge.img+1
  • Author
  • Newcomer
  • February 24, 2026

Hey ​@Leandro.Reis,

Thank you for the suggestions. I have now verified all the steps mentioned:

  1. Tested multiple locales (including de, fr, and fr_CA) by appending them correctly to the generated URL.

  2. Verified environment consistency, testing in both our Demo/Sandbox and Production environments with the same failing result.

  3. Confirmed profile settings do not resolve the issue; the locale parameter should act as an override regardless of the sender's default profile language, but it is being ignored in the createSenderView (though it works perfectly in createRecipientView).

Since this appears to be a bug or a limitation in the current EnvelopeViewRequest implementation, I would like to escalate this to your engineering team.

What is the best process for me to get this data to you? Should I open a formal ticket via the Docusign Support Center?


Leandro.Reis
Docusign Employee
Forum|alt.badge.img+3
  • Docusign Employee
  • February 26, 2026

Hi ​@Yaugen ,

Yes. Please open a support ticket so we can investigate the incident reported and, if that’s the case, open an internal ticket with the engineering team for investigation.

Make sure to add as much details as possible in the case (screenshots, videos, endpoints/methods used, detailed explanation of your process, etc). The more information you provide, the easier will be for us to replicate the issue and file a issue internally.

Regards,

Leandro Reis