Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Intake

Create an intake submission for a matter

post/intake/{matterId}/submissions

Path parameters

matterIdstring required

Matter to associate the submission with.

Request body

formIdstring nullable

Id of the intake form to create a submission for.

communicationMethod'email' | 'communicate'

Specifies the communication method used when creating an intake submission

Example request

{
  "formId": "ae4bc84e-b601-4767-9d0f-5d078832418e",
  "recipient": {
    "contactId": "5d9b8697-8c6f-45dd-b22d-87045ed4df35",
    "email": "client@example.com",
    "name": "Sample Client"
  }
}

Response

Created

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable
linkstring nullable

URL to complete the intake submission.

Example response

{
  "link": "https://example.smokeball.com/intake/submissions/e8b673fe-5493-4b1f-986c-af82542fb6d8"
}