recipient

The package recipient, present when a valid recipient_token query parameter exists in the package URL. Recipients are configured in the package settings.

ACCESS

Directly accessible in:

Package

Example

{
  "id": 1,
  "package_id": 1,
  "token": null,
  "name": null,
  "email": "contact@client.com",
  "last_viewed_at": "2025-01-31 12:00:00",
  "selections": [{
    "id": 1,
    "package_recipient_id": 1,
    "package_model_id": 1,
    "is_selected": null,
    "comments": null,
    "timestamp": "2025-01-31 12:00:00",
    "model_name": "Sarah Jones",
    "model_headshot_url": "https://cdn.syngency.com/[agencyId]/models/[modelId]/headshots/[imageId].jpg?[cacheString]"
  }]
}

Properties

id integer

package_id integer

token string

name string

email string

last_viewed_at datetime

selections array

Models selected or shortlisted by this recipient.

id integer

package_recipient_id integer

package_model_id integer

is_selected boolean

comments string

timestamp datetime

model_name string

model_headshot_url string

Format: absolute-url