Targeted Respondents
Diaform projects can run in two access modes:
- Public link: anyone with the share URL can start a new conversation
- Invite-only links: only respondents with a generated link can start or resume a conversation
Use Invite-only links when you want to:
- send a unique link to a specific person
- attach your own identifiers such as
external_user_id - keep the link alive until that conversation is finished
- stop the link from being reused once the conversation is completed
How It Works#
- Open the project's General settings.
- Change Respondent access to Invite-only links.
- Generate a respondent link manually, or create links programmatically via the API.
- Send that link to the intended respondent.
- Diaform creates the conversation only after that targeted link is opened.
- The same link resumes the same conversation until it is completed.
- Once the conversation is completed, the link stops working.
What Metadata You Can Attach#
Each respondent link can carry:
invitee_emailexternal_user_idexternal_account_idmetadataas a JSON object
Diaform copies those values onto the conversation record. They are then available in:
- the Respondent Conversations API
- webhook payloads for
conversation.completed - CSV exports
Security Model#
Targeted respondent links are bearer links. Anyone who has the full link can open it.
That means:
- Diaform enforces that the conversation can only be started through a valid generated link
- Diaform does not verify the respondent’s mailbox or identity in v1
- if you need stronger identity guarantees, launch the link from your own authenticated product surface
Programmatic Access#
Enterprise workspaces can generate respondent links programmatically with organization API keys.
See: