CaraCara API
API ReferenceForms

Submit a form

Submit a completed form with field values.

Submit a completed form with field values.

POST
/forms/{id}/submit

Authorization

AuthorizationRequiredBearer <token>

Use your API key (sk_live_* or sk_test_*) as the Bearer token.

In: header

Request Body

application/jsonRequired
fieldsobject

Key-value pairs of field IDs to submitted values.

patientIdstring

Optional patient ID to associate with the submission.

Path Parameters

idRequiredstring
curl -X POST "https://platform.caramedical.com/api/v1/forms/<string>/submit" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "fields": {},
    "patientId": "string"
  }'

Form submitted successfully.

{
  "submissionId": "string",
  "message": "string"
}

Previous

List forms

Next

Create an email sequence