Zipwhip Deep Link Format
To create a Zipwhip Deep Link, compose a URL in the following format:
https://app.zipwhip.com/messaging/{phoneNumber} where {phoneNumber} is the phone number of the person you want to send a text message to.
For example, if you want to send a text message to the mobile number (503) 575-2449, create a link pointing to this URL:
https://app.zipwhip.com/messaging/5035752449
Paths & Parameters
| Key | Description |
|---|---|
Base URL (required) |
The path to https://app.zipwhip.com is required. If no additoinal parameters are provided the link will simply open the Zipwhip app with no conversation selected. Example:https://app.zipwhip.com |
Phone Number (required) |
The mobile phone number you wish to send the message to. The mobile phone number should be formatted as a string, either as a 10-digit US phone number without any punctuation symbols or spaces (e.g. 2065551234), or in E.164 format containing a ‘+’ followed by the ‘country code’ followed by the ‘mobile phone number’ (e.g. +12065551234). Example:https://app.zipwhip.com/messaging/5035752449You can create an outgoing message addressed to multiple phone numbers as well. See Group Messaging for more info. |
Name (optional) |
The first and/or last name of the contact. You may append an optional name associated to the phone number, and the name and phone number will be automatically saved to your list of Contacts in Zipwhip. For example, the URL /5035752449 Steve Smith will create a Steve Smith entry in the Zipwhip Contact List for that phone number. Note: The spaces in the URL must be URL encoded by replacing each space character with %20. Example:https://app.zipwhip.com/messaging/5035752449%20Steve%20Smith |
overwrite=true (optional) |
If a name parameter is included, and a contact already exists in Zipwhip with that phone number, the contact name will not be overwritten. If you include the overwrite=true param, it will update the existing contact name in Zipwhip. Example:https://app.zipwhip.com/messaging/5035752449%20Stephen%20Smith?overwrite=true |
body (optional) |
You can include an optional body parameter in the URL to prepopulate the message body in the Zipwhip compose box before sending the message. You could use this parameter to pre-fill the body with metadata from your CRM, such as an account number or status message. For example, the URL /5035752449?body=Hello World will create a new outgoing message to the specified phone number with the words “Hello World” inserted into the Zipwhip compose box. The message body can be edited further before clicking Send. Note: The spaces in the URL must be URL encoded by replacing each space character with %20. Example:https://app.zipwhip.com/messaging/5035752449?body=Hello%20World |
Dynamic Fields (optional) |
Zipwhip provides the ability to insert Dynamic Fields into the body of the text message. For example, if you’d like to greet the recipient by their first name, you could prepopluate the message body with the [First Name] dynamic field. The following dynamic fields are supported:• [First Name]• [Last Name]• [Company]• [Job Title]• [Email]• [Address Line 1]• [Address Line 2]• [City]• [State]• [Postal Code]• [Country]• [Custom Field 1]• [Custom Field 2]You may include one or more of the dynamic fields listed above into the body of the text message. You must include the square brackets [ ] around the Dynamic Field and URL encode any spaces. Example: https://app.zipwhip.com/messaging/5035752449?body=Hi%20[First%20Name]! |
Authentication |
The authentication method used for logging into Zipwhip. Options are: • Automatic — Zipwhip will prompt the user to login the first time and store their credentials as a browser cookie. The user will be automatically logged in after that. **• Session** — You provide a session key that automatically logs the user into the appropriate Zipwhip account. • **SSO** (Enterprise customers only) — You provide your SSO connection name parameter to log the user into the appropriate Zipwhip account. See Authentication for more info. |
Group Messaging
You may create an outgoing text message that is addressed to multiple recipients (a Group message) by including multiple phone numbers in the URL separated by commas.
https://app.zipwhip.com/messaging/5035752449,2068163997
As in the examples above, each phone number can include an optional name and each name will be saved to the Zipwhip Contact List:
https://app.zipwhip.com/messaging/5035752449%20Steve%20Smith,2068163597%20Sally%20Jones
A message body can be included as well to send canned text to a group of recipients:
https://app.zipwhip.com/messaging/5035752449,2068163997?body=Hello%20World
And group message can contain a message body with dynamic fields that will be updated with specific information for each contact:
https://app.zipwhip.com/messaging/5035752449%20Steve%20Smith,2068163597%20Sally%20Jones?body=Hi%20[First%20Name]!