Intakes

Edit an intake

Edit project name, due date, chase cadence, and the client's name/phone/language/timezone on an existing intake — the alternative used to be deleting it and creating a new one, which re-sends the invitation. client.email cannot be changed here: the portal link and magic token are bound to it, so add, remove, or reinstate addresses through the recipients endpoints instead. Every field is optional but at least one is required (400 otherwise); null clears owner_note, client_brief, due_date and chase_at_time, omitting a field always leaves it untouched. On a sent, in_progress or stalled intake, changing any cadence-related field (chase_schedule, chase_interval, chase_interval_unit, chase_at_time, max_reminders, respect_quiet_hours, client.timezone, due_date) cancels every still-scheduled reminder and re-plans under the new settings; attempt numbering is unaffected. Raising max_reminders (or setting it to "unlimited") past the number of reminders already sent un-stalls a stalled intake and resumes automatic chasing. Refused with 409 conflict on an archived intake.

patch/v1/intakes/{id}

Request

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

Path parameters

idstring required

Intake ID

Request body

owner_notestring nullable
client_briefstring nullable

See client_brief on POST /v1/intakes. null clears it; an empty string is also stored as null.

project_namestring
due_datestring date nullable

YYYY-MM-DD

chase_schedule'default' | 'gentle' | 'aggressive' | 'custom' | 'off'
chase_intervalinteger

Only meaningful with chase_schedule="custom".

chase_interval_unit'minutes' | 'hours' | 'days'
chase_at_timestring nullable

24-hour local time, e.g. "07:00". Needs a whole-day interval.

respect_quiet_hoursboolean
folder_idstring nullable

Move the intake into this folder, or null to move it to Unfiled. Must name a folder on the caller's own account (400 invalid_request, reason validation_error, otherwise). Never affects status, chases, or anything else about the intake. See Folders.

Response

Updated intake

Example response

{
  "intake": {
    "intake_id": "in_01J9Z8X"
  }
}

Changes

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