Skip to main content
POST
/
packages
/
{packageId}
/
link
/
edit
Edit
curl --request POST \
  --url https://sandbox.syngrafii.com/api/v1/packages/{packageId}/link/edit \
  --header 'api_key: <api-key>'
{
  "packageId": "<string>",
  "name": "<string>",
  "link": "<string>",
  "type": "<string>",
  "token": "<string>",
  "timeExpires": "<string>"
}
Generate a secure link to allow editing of a package without requiring authentication.
You will have to refresh the package edit link before it expires. The link is short lived for security reasons.

​
Request

Request
POST /packages/{packageId}/link/edit

​
Parameters

​
packageId
string
required
The unique identifier of the package you want to generate an edit link for.

​
Response

​
packageId
string
Unique identifier of the package the link was generated for.
​
name
string
Display name for of the package the link was generated for.
​
link
string
URL that grants access to the package.
​
type
string
default:"package_edit"
Type of link returned.
​
token
string
Token generated to provide access to the package.
​
timeExpires
string
Timestamp when the link expires (ISO 8601 format).

​
Examples

Response (200)
{
    "name": "Signing",
    "link": "https://sign.syngrafii.com/link/6iC4sCyjRaMTm2FcMjwIVA",
    "type": "package_edit",
    "token": "6iC4sCyjRaMTm2FcMjwIVA",
    "timeExpires": "2021-08-10T15:40:51.7746401Z",
    "packageId": "581aa1e0-49ea-4e49-841a-a74050e7d776"
}