Intakes

Create intake

Create a new client intake. If send is true (the default), the client receives an invite email immediately and the intake moves to sent. If send is false, the intake stays as draft until POST /v1/intakes/:id/send is called.

Supply an Idempotency-Key header (max 128 chars) to make this operation safe to retry — duplicate requests within 24 hours return the original response.

post/v1/intakes

Request

  • Base URL: https://api.briefgate.dev
  • URL: https://api.briefgate.dev/v1/intakes
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Idempotency key for safe retries. Cached for 24 hours.

Request body

project_namestring required
due_datestring
client_briefstring
chase_schedule'default' | 'gentle' | 'aggressive' | 'custom' | 'off'
chase_intervalinteger
chase_interval_unit'minutes' | 'hours' | 'days'
respect_quiet_hoursboolean
chase_at_timestring
templatestring

Slug of a saved template (GET/POST /v1/templates). Template items are merged with items above by key, with items winning on a clash. A template can also carry every other setting below (chase cadence, retention, branding, folder, ...) as defaults: such a setting applies only where this request body itself leaves the matching field unset — anything the request sets explicitly always wins over the template, field by field.

auto_approve_hoursinteger
folder_idstring
sendboolean

Response

Intake created

intake_idstring required
portal_urlstring uri required
status'draft' | 'sent' required
invitation_sentboolean

Present and false only when an invitation limit was hit — the hourly one, or the daily one a plan may carry (invites_per_day in /pricing.json); the intake was created as a draft instead.

notestring

Present alongside invitation_sent: false, explaining what to do next.

Example response

{
  "intake_id": "in_01J9Z8X",
  "follow_up": {
    "webhook": {
      "register_with": "manage_webhook"
    },
    "schedule": {
      "check_with": "get_intake_status"
    }
  }
}

Changes

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