Skip to main content
POST
Claim the preview after signing in

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

run_id
string<uuid>
required

Body

application/json

Which sign-in the person used, so the campaign sends from that mailbox.

mailbox
enum<string>
default:gmail

gmail after Continue with Google, outlook after Continue with Microsoft.

Available options:
gmail,
outlook

Response

Successful Response

What a sign-in made of the preview.

colleague_org_id
string | null
required

A workspace colleagues at the company are in; the campaign then waits.

colleague_org_name
string | null
required
gmail_needed
boolean
required
deprecated

Deprecated: mail_grant_needed for a Gmail sign-in. Kept one release.

mail_grant_needed
boolean
required

The sign-in has not allowed mail send and read yet, so nothing launched: ask the provider for them (Clerk reauthorize with the mail scopes), then claim again.

mailbox
enum<string>
required

The mailbox the campaign sends from.

Available options:
gmail,
outlook
org_id
string
required

The workspace the person now owns; make it the active one.

sequence_id
string<uuid> | null
required