Juno
API reference

Create participant link

create_participant_link Requires links:write

Create an invite link carrying what you already know about the people who will open it — company, role, the systems they use. Juno briefs the interviewer with it so the interview does not ask for details you supplied. By default the link is for a group: send one link to everyone in that segment. Set audience='person' when the context identifies one individual and you want the finished interview matched back to their record; that link then belongs to whoever opens it first. The context is recorded on the resulting interview and returned by list_interviews. Use note for free-text direction (what to explore, why these people matter) — it is briefed to the interviewer but never becomes interview data.

Input

study_id
string <uuid>

Unique study id returned by Juno.

context
object | null

Key/value facts about the people this link is for, e.g. {"company": "Coca-Cola", "role": "Head of Martech"}. At most 20 keys; keys up to 100 characters, values up to 2048, 16KB total.

audience
enum("group", "person")

Who the link is for. 'group' (the default) describes a segment — everyone you send it to gets this context, so one link covers a whole company or role. Use 'person' when the context identifies one individual (e.g. a contact_id you want the finished interview matched back to): the link then addresses one interview. Reopening that same link continues the interview with its original context, even in another browser or device. Give each different participant a fresh person link and treat it as sensitive.

note
string | null

Free-text direction for the interviewer about the people this link is for, e.g. 'These participants recently cancelled. Explore what changed and why they left.' Unlike context (facts, which become data columns on the interview), the note is guidance Juno follows during the conversation. Up to 2048 characters. Never shown to the participant and never included in exports.

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_participant_link",
    "arguments": {
      "study_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "context": null,
      "audience": "group",
      "note": null
    }
  }
}