provider user_interview_topics POST /api/projects/{project_id}/user_interview_topics/{id}/send_invites/
@utdk/posthog /api/projects/{project_id}/user_interview_topics/{id}/send_invites/
user_interview_topics_send_invites_create
Generate (if needed) and email a personalized public interview link to every targeted interviewee on this topic whose identifier is an email address. Distinct-ID-only interviewees are skipped and surfaced in the response. Each invite is keyed on the underlying SharingConfiguration so re-runs after token rotation produce a fresh send.
id path required
A UUID string identifying this user interview topic.
string
project_id path required
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
string

Try it

Authentication
Configure credentials for PostHog API
userInterviewTopicsSendInvitesCreate
POST/api/projects/{project_id}/user_interview_topics/{id}/send_invites/
Generate (if needed) and email a personalized public interview link to every targeted interviewee on this topic whose identifier is an email address. Distinct-ID-only interviewees are skipped and surfaced in the response. Each invite is keyed on the underlying SharingConfiguration so re-runs after token rotation produce a fresh send.

Parameters

required

A UUID string identifying this user interview topic.

required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Input

Override the email subject line for this send. Plain text only — URLs, angle brackets, and control characters are rejected. Falls back to the topic's saved subject, then a default.

Email address replies should go to. Defaults to the topic creator's email if blank.

If true (default), queue delivery via Celery. If false, send synchronously and surface errors immediately.

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.userInterviewTopicsSendInvitesCreate({
  "send_async": true
})