Create Snapshot Share Link

POST 
/snapshots/share/link

Create a share link for snapshot

Request

Version stringrequired

API Version

Available optionsv3

companyId stringrequired

application/json

application/json

Body

Bodyrequired

snapshot_idstringrequired

id for snapshot to be shared

share_typestringrequired
Type of share link to generate
Available optionslinkpermanent_linkagency_linklocation_link
relationship_numberstring

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

share_location_idstring

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

Example (auto)

{
  "snapshot_id": "1eM2UgkfaECOYyUdCo9Pa",
  "share_type": "permanent_link",
  "relationship_number": "0-128-926,1-208-926,2-008-926",
  "share_location_id": "l1C08ntBrFjLS0elLIYU, U1C08ntBrFjLS0elKIYP"
}

application/json

Successful response

application/json

Schema

Schema

idstring

id for shared snapshot

shareLinkstring

Share Link for snapshot

Example (auto)

{
  "id": "1eM2UgkfaECOYyUdCo9Pa",
  "shareLink": "https://affiliates.gohighlevel.com/?share=1eM2UgkfaECOYyUdCo9Pa"
}