Skip to content
OnCoreDocs
Capture Forms

PATCHhttps://core-api.heysadie.ai/capture-forms/{id}

id assistantId name trigger introMessage emailRecipients smsRecipients fields key question type action required options wait_for_response prompt properties isActive success data createdAt updatedAt metadata timestamp version path error code message details field

Update capture form

Try it in the API Explorer

Example request

Terminal
curl -X PATCH "https://core-api.heysadie.ai/capture-forms/CAPTURE_FORM_ID" \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "assistantId": "0195f1e2-0000-7000-8000-000000000000",
    "name": "string",
    "trigger": "string"
  }'

Authentication

Authenticate with an API key in the Authorization header using the ApiKey scheme — see Authentication for how keys work and where to get them.

Authorizationstringrequired

API key in the ApiKey scheme: ApiKey YOUR_API_KEY. Tenant keys authorize their own tenant; organization keys can act on any tenant in the organization.

X-Tenant-Idstring (uuid)optional

Required when authenticating with an organization key — selects the tenant the request acts on. Omit with tenant keys.

Request

Path parameters

idstringrequired

The resource's UUID.

Body application/json · required

assistantIdstring (uuid)optional
namestringoptional
triggerstringoptional
introMessagestringoptional
emailRecipientsstring (email)[]optional
smsRecipientsstring[]optional
fieldsobject[]optional
Show 8 item properties
keystringrequired
questionstringrequired
typestringrequired
actionstringoptional
requiredbooleanoptional
optionsstring[]optional
wait_for_responsebooleanoptional
promptstringoptional
propertiesanyoptional
isActivebooleanoptional

Responses

200
successbooleanrequired
dataobjectoptional
Show 12 child properties
idstringrequired
assistantIdstringrequired
namestringrequired
triggerstringrequired
introMessagestringrequired
emailRecipientsstring[] | nullrequired
smsRecipientsstring[] | nullrequired
fieldsobject[]required
Show 8 item properties
keystringrequired
questionstringrequired
typeenumrequired
Allowed values:"string""number"
actionstringoptional
requiredbooleanoptional
optionsstring[]optional
wait_for_responsebooleanoptional
promptstringoptional
propertiesanyrequired
isActiveboolean | nullrequired
createdAtstring (date-time) | string (date) | number | nullrequired
updatedAtstring (date-time) | string (date) | number | nullrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
400
successbooleanrequired
errorobjectoptional
Show 3 child properties
codeenumrequired
Allowed values:"VALIDATION_ERROR"
messagestringrequired
detailsobject[]optional
Show 2 item properties
fieldstringrequired
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
401
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"UNAUTHORIZED"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
403
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"FORBIDDEN"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
404
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"RESOURCE_NOT_FOUND"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
500
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"INTERNAL_SERVER_ERROR"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional