Create Inquiries
API to create new inquiries in Monolith
Create an inquiry
POST
/api/v1/inquiries
Create a new inquiry in Monolith vai HTTPS
Headers
Name | Type | Description |
---|---|---|
x-api-key* | String | Monolith API Key |
Request Body
Name | Type | Description |
---|---|---|
client* | JSON | A JSON object with client info. |
request_name | String | A name for this inquiry. |
request_id | String | This is the request_id of the inquiry. This value is usually associated with a Relay request, but can also be associated with external request systems if utilized via API when creating an inquiry. |
client_ref_number | String | A case or matter number related to the requestor. |
description | String | A description of the inquiry - usually the details of the request being made. |
inquiry_type | String | Type of inquiry - should map to the case types in your Monolith database. |
referred_by | String | Source of inquiry - defaults to "API Request" |
evidence | Array | This is an array of evidence objects. |
client.name* | String | Name of the requestor. |
client.email* | String | Email of requesting client. |
client.org | String | Organization of requestor. |
client.phone | String | Office phone number of requestor. |
client.mobile | String | Mobile phone number of requestor. |
client.address | String | Address of requestor. |
client.city | String | City of requestor. |
client.region | String | State or province of requestor. |
client.postal_code | String | Postal code for requestor. |
client.type | String | Type of client |
evidence.evidence_number | String | Evidence number for requestor |
evidence.item_name* | String | Name of evidence item. |
evidence.provider | String | Manufacturer or service provider. |
evidence.evidence_type | String | Type of evidence - should map to evidence types in Monolith. |
evidence.unique_id | String | Serial number or account identifier for evidence item. |
evidence.description | String | Description of evidence. |
contacts | Array | Array of contact objects |
contacts.name* | String | Name of person. |
contacts.type | String | Type of contact/person. |
contacts.unique_id | String | Identifier of person. |
contacts.description | String | Description or notes related to person. |
documents | Array | Array of document objects |
documents.name* | String | Filename of document |
documents.data* | String | Base64 encoded string of file data. |
Create Inquiry Example
Last updated