Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add text around using merge variables for QR codes #492

Merged
merged 2 commits into from
May 21, 2024

Conversation

vmangwani
Copy link
Contributor

Checklist

  • Up to date with main
  • All the tests are passing
    • Delete all resources created in tests
  • Prettier
  • Spectral Lint
  • npm run bundle outputs nothing suspect
  • npm run postman outputs nothing suspect

Changes

We are now using merge_variables for QR code as well. Updating the docs for PLCS and Campaigns endpoints to share details around how to use them.

@vmangwani vmangwani requested a review from a team May 21, 2024 19:47
@vmangwani vmangwani requested a review from a team as a code owner May 21, 2024 19:47
@@ -30,7 +30,7 @@ properties:

redirect_url:
type: string
description: The url to redirect the user when a QR code is scanned. The url must start with `https://`
description: The url to redirect the user when a QR code is scanned. The URL can be an inline URI or a merge_variable(enclosed in curly braces) or a combination of both. For example, `https://www.example.com` or `{{name}}` or `https://www.google.com?q={{name}}`. When the URL is/has a merge variable, it is replaced with data from merge_variables. If the variable does not exist, then nothing with be replaced and the destination URL will be the same as the input URL. More details on merge variables can be found in <a href="https://help.lob.com/print-and-mail/designing-mail-creatives/adding-qr-codes#destination-url-and-redirects" target="_blank">our help center</a>.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: The url to redirect the user when a QR code is scanned. The URL can be an inline URI or a merge_variable(enclosed in curly braces) or a combination of both. For example, `https://www.example.com` or `{{name}}` or `https://www.google.com?q={{name}}`. When the URL is/has a merge variable, it is replaced with data from merge_variables. If the variable does not exist, then nothing with be replaced and the destination URL will be the same as the input URL. More details on merge variables can be found in <a href="https://help.lob.com/print-and-mail/designing-mail-creatives/adding-qr-codes#destination-url-and-redirects" target="_blank">our help center</a>.
description: The url to redirect the user when a QR code is scanned. The URL can be a literal URL, a template URL containing merge variables, or consist entirely of merge variables. For example, `https://www.example.com` or `https://www.example.com?q={{name}}` or `{{name}}`, respectively. When a merge variable exists in the URL, it is replaced with data from merge_variables. If the variable does not exist, then nothing with be replaced and the destination URL will be the same as the input URL. More details on merge variables can be found in <a href="https://help.lob.com/print-and-mail/designing-mail-creatives/adding-qr-codes#destination-url-and-redirects" target="_blank">our help center</a>.

What do you think about this wording? Also, probably best to keep with example.com in the docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah! Thanks for checking I like the one you suggested better. I'll update it in a sec.

oneOf:
- $ref: "../attributes/single_redirect_url.yml"
- $ref: "../attributes/customized_redirect_url.yml"
The url to redirect the user when a QR code is scanned. The URL can be a standard URL for all recipients in the campaign or customized per recipient. To customize for each recipient, use a mustache style template with merge variables enclosed in curly braces(for example, `https://www.example.com` or `{{name}}` or `https://www.google.com?q={{name}}`). If a merge variable is used in the URL, a mapping to that merge variable should be provided in the `mergeVariableColumnMapping` property when creating an upload. If the variable is not provided/does not exist, then the templated URL will be used. More details on customizing redirect URLs can be found in <a href="https://help.lob.com/print-and-mail/designing-mail-creatives/adding-qr-codes#destination-url-and-redirects" target="_blank">our help center.</a>.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The url to redirect the user when a QR code is scanned. The URL can be a standard URL for all recipients in the campaign or customized per recipient. To customize for each recipient, use a mustache style template with merge variables enclosed in curly braces(for example, `https://www.example.com` or `{{name}}` or `https://www.google.com?q={{name}}`). If a merge variable is used in the URL, a mapping to that merge variable should be provided in the `mergeVariableColumnMapping` property when creating an upload. If the variable is not provided/does not exist, then the templated URL will be used. More details on customizing redirect URLs can be found in <a href="https://help.lob.com/print-and-mail/designing-mail-creatives/adding-qr-codes#destination-url-and-redirects" target="_blank">our help center.</a>.
The url to redirect the user when a QR code is scanned. The URL can be a standard URL for all recipients in the campaign or customized per recipient. To customize for each recipient, use a mustache style template with merge variables enclosed in curly braces(for example, `https://www.example.com` or `{{name}}` or `https://www.example.com?q={{name}}`). If a merge variable is used in the URL, a mapping to that merge variable should be provided in the `mergeVariableColumnMapping` property when creating an upload. If the variable is not provided/does not exist, then the templated URL will be used. More details on customizing redirect URLs can be found in <a href="https://help.lob.com/print-and-mail/designing-mail-creatives/adding-qr-codes#destination-url-and-redirects" target="_blank">our help center.</a>.

@vmangwani vmangwani enabled auto-merge (squash) May 21, 2024 20:20
@vmangwani vmangwani merged commit 5ed25a8 into main May 21, 2024
6 checks passed
@vmangwani vmangwani deleted the update_docs_with_merge_variables branch May 21, 2024 21:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants