provider user_interview_topics POST /api/environments/{environment_id}/user_interview_topics/{id}/preview_invite/
@utdk/posthog /api/environments/{environment_id}/user_interview_topics/{id}/preview_invite/
environments_user_interview_topics_preview_invite_create
Render the invite email exactly as a specific targeted interviewee would receive it — personalized subject and body — without sending anything and without creating or reading any share links. Pass `interviewee_identifier` to preview for a particular person, or omit it to preview for the first targeted interviewee. The body always shows an illustrative placeholder link (`is_preview_link: true`), never a live interview URL.
environment_id path required
Deprecated. Use /api/projects/{project_id}/ instead.
string
id path required
A UUID string identifying this user interview topic.
string

Try it

Authentication
Configure credentials for PostHog API
environmentsUserInterviewTopicsPreviewInviteCreate
POST/api/environments/{environment_id}/user_interview_topics/{id}/preview_invite/
Render the invite email exactly as a specific targeted interviewee would receive it — personalized subject and body — without sending anything and without creating or reading any share links. Pass `interviewee_identifier` to preview for a particular person, or omit it to preview for the first targeted interviewee. The body always shows an illustrative placeholder link (`is_preview_link: true`), never a live interview URL.

Parameters

required

Deprecated. Use /api/projects/{project_id}/ instead.

required

A UUID string identifying this user interview topic.

Input

Which targeted interviewee to render the preview for (an email or PostHog distinct ID already on the topic). Leave blank to preview for the first targeted interviewee.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.environmentsUserInterviewTopicsPreviewInviteCreate()