Skip to main content
SnapshotsVersion: v3

Create Snapshot Share Link

POST/snapshots/share/link

Create a share link for snapshot

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Auth methods:OAuthPrivate Integration
Token type:Agency Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Query Parameters

companyIdstringrequired

Body

snapshot_idstringrequired

id for snapshot to be shared

Example:1eM2UgkfaECOYyUdCo9Pa
share_typestringrequired

Type of share link to generate

Available optionslinkpermanent_linkagency_linklocation_link
Example:permanent_link
relationship_numberstring

Comma separated Relationship number of Agencies to create agency restricted share link

Example:0-128-926,1-208-926,2-008-926
share_location_idstring

Comma separated Sub-Account ids to create sub-account restricted share link

Example:l1C08ntBrFjLS0elLIYU, U1C08ntBrFjLS0elKIYP

Response

Successful response

idstring

id for shared snapshot

Example:1eM2UgkfaECOYyUdCo9Pa
shareLinkstring

Share Link for snapshot

Example:https://affiliates.gohighlevel.com/?share=1eM2UgkfaECOYyUdCo9Pa