Skip to content
Extrovert Extrovert Docs

Save unverified gift contact and code availability

POST
/v1/gift-intents

Does not reserve capacity, establish account ownership, or activate Startup. Maximum request body 4 KiB.

Request Body required

Section titled “Request Body required ”
object
human_email
required
string format: email
<= 254 characters
gift_code
required
string
<= 64 characters
source
string
<= 128 characters
referrer
string
<= 512 characters
agent_client
object
name
string
<= 128 characters
version
string
<= 64 characters

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Contact saved

object
intent
required
object
id
required
string
human_email
required

Unverified contact only.

string format: email
gift_code
string
campaign_id
string
code_id
string
outcome
required
string
created_at
string format: date-time
expires_at
string format: date-time
source
string
referrer
string
agent_client
object
name
string
<= 128 characters
version
string
<= 64 characters
offer
object
campaign_id
required
string
name
required
string
plan_tier
string
Allowed values: startup
duration_days
required
integer
Allowed values: 30
opens_at
required
string format: date-time
redeem_before
required
string format: date-time
monthly_price_cents
integer format: int64
currency
string
included_inboxes
integer
included_projects
integer
resume_token

Opaque secret returned only when creating an intent. Store securely; never put in a URL.

string

400

Section titled “400 ”

Invalid request.

The canonical error envelope. error is a stable machine code.

object
error
required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string
Example
forbidden
message

Human-readable detail (never leaks internals).

string
Example
missing required scope
reason

Machine-readable quota reason. inbox_limit_exceeded means billing account inbox capacity across all organizations and projects sharing that account; enrollment_token_mailbox_budget_exhausted means the enrollment key lifetime creation allowance. Read message for recovery; inbox counts are separate from sending quotas.

string
used

Consumed plus reserved units.

integer format: int64
delta

Requested additional units.

integer format: int64
limit
integer format: int64
remaining
integer format: int64
consumed
integer format: int64
reserved
integer format: int64
next_reset_at

Next UTC usage-period boundary; pending reservations survive this boundary.

string format: date-time
upgrade_required
boolean