organizations
invites

Create an onboarding delegation invite: an admin-level invite flagged as a setup delegation. Sends a single dedicated delegation email and records the inviting user as having delegated.

post/api/organizations/{organization_id}/invites/delegate/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/organizations/{organization_id}/invites/delegate/
  • Auth: HTTP bearer

Path parameters

organization_idstring required

ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/.

Request body

target_emailstring email required

Email of the teammate who should complete setup on the inviter's behalf. Receives a PostHog-branded delegation invite granting admin-level membership on accept.

messagestring

Optional personal message included in the delegation email (up to 1000 characters).

step_at_delegationstring

Onboarding step key the delegator was on when delegating, for analytics only.

Response

idstring uuid required
target_emailstring email required
first_namestring
emailing_attempt_madeboolean required
level1 | 8 | 15
  • 1 - member
  • 8 - administrator
  • 15 - owner
is_expiredboolean required

Check if invite is older than INVITE_DAYS_VALIDITY days.

created_atstring date-time required
updated_atstring date-time required
messagestring nullable
private_project_accessunknown
send_emailboolean
combine_pending_invitesboolean

Changes

No recorded changes to this operation across all 1 revision of this API.