Hosted Links
The hosted acceptance page is a ToughClicks page that shows a packet (and optionally a form) to a signer. You don't need to embed anything on your own site. You send the signer a link, they accept, and they go to a thank-you page or back to your site.
Hosted Links let you set that page up from dropdowns in the Management Portal and share a short URL:
https://app.toughclicks.com/accept/{linkId}
The settings are stored with the link. If you edit the link, every URL you already shared uses the new settings, so you don't have to send it again.
Who can use Hosted Links
- The Hosted Links menu item is available to users with the Organization Admin role (permissions
READ_HOSTED_LINKandWRITE_HOSTED_LINK). - Hosted Links and hosted forms are part of the hosted forms feature of your plan. Contact your ToughClicks account manager if it is not included.
Creating a Hosted Link
- Sign in to the ToughClicks Management Portal and open Hosted Links.
- Click Add Hosted Link and fill in:
| Field | Required | Description |
|---|---|---|
| Name | Yes | A name for your own reference, e.g. "Customer onboarding". |
| Client (API key) | Yes | The client the page uses. Only clients that have not expired are listed. |
| Packet | Yes | The packet the signer accepts. |
| Form | No | A form shown above the packet. If the form has a required email field, the signer is taken from it. |
| Return URL | No | An https:// URL the signer is sent to after accepting. Without one, they see the ToughClicks thank-you page. |
- Click Save. The builder then shows the link's URL with a Copy button. The list of Hosted Links also has a copy button on every row.
You can also start from a packet or a form: on the Packets or Forms list, click the link icon (Get hosted link) next to its name to open the builder with that packet or form selected.
Identifying the signer
Each acceptance is recorded for a signer. The hosted page uses the first of these that is available:
signerIdin the URLsignerEmailAddressin the URL- The form's required email field
If a link has no form, add the signer to each recipient's URL:
https://app.toughclicks.com/accept/{linkId}?signerId={signerId}&signerEmailAddress={signerEmailAddress}
Replace {signerId} and {signerEmailAddress} with the recipient's values, and URL-encode them (for example @ becomes %40). You only need one of the two. For links without a form, the builder shows two per-recipient URLs, one with signerId and one with signerEmailAddress. A placeholder left unfilled (still {signerId}) is ignored, not used as the signer.
Values in the URL take precedence over the form's email field. If you send signerId, acceptances are recorded for that ID even when the signer types a different email address in the form.
If the page can't identify the signer, it says so instead of showing the packet.
Custom domains
If your organization has a custom domain, the builder uses it for the URLs it shows. A custom domain only shows its own organization's links and packets; another organization's link opened on it is unavailable:
https://legal.yourdomain.com/accept/{linkId}
The same link also works on app.toughclicks.com.
When a link is unavailable
The page shows "This link is unavailable" instead of the packet when:
- the link was deleted,
- its client has expired or was deleted,
- its packet was deleted,
- its form was deleted, or the form can't be loaded,
- it is opened on a custom domain that belongs to another organization.
The Hosted Links list marks unavailable links and says why (client expired, client deleted, packet deleted, form deleted). Open the link to fix it: the builder names the reference that is gone and clears it, so you can pick a replacement. A deleted form is removed from the link when you save, unless you choose another.
If the organization has been deactivated, the page shows "This page is unavailable".
Full URL (advanced)
The builder's Show full URL (advanced) option shows the same page with every setting in the query string. This is the original hosted page URL format, and it keeps working:
https://app.toughclicks.com/accept?token={clientId}&packetId={packetId}&formId={formId}&signerId={signerId}&signerEmailAddress={signerEmailAddress}&returnURL={returnUrl}
A full URL doesn't change when you edit a Hosted Link. Use the short /accept/{linkId} URL if you want later edits to apply.
Query parameters
| Parameter | Also accepted as | Required | Description |
|---|---|---|---|
token | Token | Yes | Client ID of the client the page uses. |
packetId | PacketId | Yes | The packet to accept. Only one packet per page. |
formId | FormId | No | A form of the same organization as the client. If the form can't be loaded (deleted, or of another organization), the page shows "This link is unavailable". |
signerId | SignerId | One of these, or a form with a required email field | Identifier of the signer. Used first. |
signerEmailAddress | SignerEmailAddress | Email address of the signer. Used as the signer when there is no signerId. | |
returnURL | returnUrl | No | Where to send the signer after accepting. Only absolute https:// URLs are followed (no http://, //host or user@host forms); otherwise the thank-you page is shown. URL-encode the value. |
Without token and packetId the page shows nothing.
API reference
The Management Portal uses these endpoints. The organization endpoints need an Organization Admin.
| Method | Path | Description |
|---|---|---|
GET | /api/v1/hosted-link?organizationId= | List the organization's links (also returns its customDomain). Each link has unavailable and unavailableReason (CLIENT_EXPIRED, CLIENT_DELETED, PACKET_DELETED, FORM_DELETED). |
POST | /api/v1/hosted-link | Create a link: name, organizationId, clientId, packetId, optional formId and returnUrl. |
GET | /api/v1/hosted-link/{id} | Get one link. |
PATCH | /api/v1/hosted-link/{id} | Change any field. null clears formId or returnUrl. |
DELETE | /api/v1/hosted-link/{id} | Delete a link. |
GET | /api/v1/legalCenter/hosted-link/{id} | Public. Returns { id, organizationId, clientId, packetId, formId, returnUrl }. 404 for a deleted link or packet. 403 HOSTED_LINK_UNAVAILABLE for an expired or deleted client or a deleted form, and 403 ORGANIZATION_INACTIVE for a deactivated organization. |
GET | /api/v1/legalCenter/hosted-link/{id}/form | Public. The link's form. |
GET | /api/v1/legalCenter/form/{formId}?token={clientId} | Public. A form for the full URL. token is required, and the form must belong to the client's organization. |
The client, packet and form of a link must belong to the link's organization. The API refuses another organization's IDs.