Deletes the records that match a list of loan GUIDs from your loan origination system (LOS) integration, across every branch on your account. GUIDs with no matching record are skipped.
Available by request. This endpoint isn’t turned on by default. Contact Shape Support to request access.
POSThttps://secure-api.setshape.com/api/delete_if_exists/{crmid}
Before you start
- Send the API key for your corporate system in the
Authorizationheader. - Requests must come from an IP address on your system’s IP allowlist. Your Shape administrator manages the list in Shape’s IP settings. Requests from other addresses are refused with
400.
Parameters
| Parameter | Where | Required | Description |
|---|---|---|---|
crmid |
Path | Required | Your corporate system’s CRM ID. |
loanGUIds |
Body | Required | A list of up to 1,000 loan GUIDs to delete. The field name is case-sensitive. |
Example request
curl --request POST
--url "https://secure-api.setshape.com/api/delete_if_exists/YOUR_CRM_ID"
--header "Authorization: YOUR_CORPORATE_API_KEY"
--header "Content-Type: application/json"
--data '{"loanGUIds": ["3f6c2a1e-8b4d-4c7a-9e21-5d0b7f3a9c64"]}'Response
A successful response is 200 {"message": "Request queued successfully."}. This confirms Shape received your list; the deletions are queued.
Deletions are processed within one business day. Matching records stay in Shape until processing finishes.
Errors
| Situation | Status | Response |
|---|---|---|
loanGUIds isn’t a list |
400 | {"message": "Invalid ids parameter"} |
| List empty or missing | 400 | {"message": "No valid LoanGUIDs provided"} |
| More than 1,000 GUIDs | 400 | {"message": "Request rejected. Max limit hit."} |
| Address not on the allowlist | 400 |
There’s no separate daily limit beyond the usual rate limits.