Deliverables & guest review

A deliverable isn’t limited to visual designs — it can be a PDF, video, image, document, press material, or any other file an agency produces for a client. Deliverable review lives on versioned files. Staff can also share a guest link so clients approve without a portal account.

Deliverables & versions

File type (image | pdf | video | audio | document | other) is auto-detected from the upload’s MIME type and file name when a version is confirmed; use the file-type route to correct it after the fact.

Guest review shares (staff)

Create, email, or revoke a share for a pending version:

curl -X POST "$API/v1/deliverables/versions/$VERSION_ID/review-share" \
-H "Authorization: Bearer fel_..." \
-H "Content-Type: application/json" \
-d '{"email":"client@example.com"}'

const { data } = await fetch(
`${API}/v1/deliverables/versions/${versionId}/review-share`,
{
  method: 'POST',
  headers: {
    Authorization: `Bearer ${apiKey}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ email: 'client@example.com' }),
},
).then((r) => r.json())
console.log(data.shareUrl)

import requests
r = requests.post(
f"{API}/v1/deliverables/versions/{version_id}/review-share",
headers=headers,
json={"email": "client@example.com"},
)
print(r.json())

Guest review flow (public token)

These routes are authenticated by the share token (plus OTP after verify), not by agency API keys:

Typical UI path: dashboard /review/:token → email → OTP → decision.

A version response includes deliverableId and fileType alongside the usual file metadata:

{
  "version": {
    "id": "ver_123",
    "deliverableId": "del_456",
    "version": 2,
    "status": "pending",
    "fileName": "press-release-final.pdf",
    "mimeType": "application/pdf",
    "fileType": "pdf",
    "fileSize": 284213,
    "url": "https://cdn.example.com/..."
  }
}

List and detail routes wrap results in { deliverables } / { deliverable }:

{ "deliverables": [{ "id": "del_456", "name": "Q3 press kit", "projectId": "prj_789" }] }

Figma import

After connecting Figma under Settings → Integrations:

See Integrations & webhooks for OAuth connection endpoints.