API Reference›Servicing Plane›Scheduled callbacks›Start the promised call

Start the promised call

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/scheduled-callbacks/{taskId}/start-callImplementedBearer token ·START_SERVICING_SCHEDULED_CALLBACK

Places the promised call under a compliance decision evaluated at this instant, not when the promise was made. Only the accepted assigned worker may start it; a placed call moves the task to IN_PROGRESS and can return a short-lived dial grant, while a blocked one returns the blocking reason instead.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/scheduled-callbacks/$TASK_ID/start-call \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "contactPointRef": "phone-1",
  "recordingRequested": false
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/scheduled-callbacks/${taskId}/start-call`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "contactPointRef": "phone-1",
  "recordingRequested": false
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/scheduled-callbacks/{task_id}/start-call",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "contactPointRef": "phone-1",
  "recordingRequested": false
},
)

{
  "placed": true,
  "callId": 7001,
  "interactionId": 3001,
  "status": "DIAL_AUTHORIZED",
  "dialGrantRef": "grant-1f7c9a4b",
  "dialGrantExpiresAt": "2026-07-26T15: 06:00Z"
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "409",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "idempotency.request.in.flight",
  "errors": []
}

Path & query parameters

Field	Type	Description
LendEasy-Tenant required in header	string	Opaque active LendEasy tenant-registry identifier. Supply exactly one instance; no alternate tenant selector is accepted.
taskId required in path	integer	Positive numeric task identifier.
Idempotency-Key optional in header	string	Optional replay key for this logical mutation. Omission creates a fresh server-owned key for this attempt; blank, repeated, or longer-than-50-character values are rejected.

Body parameters

Field	Type	Description
contactPointRef required	string
recordingRequested required	boolean

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/scheduled-callbacks/$TASK_ID/start-call \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "contactPointRef": "phone-1",
  "recordingRequested": false
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/scheduled-callbacks/${taskId}/start-call`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "contactPointRef": "phone-1",
  "recordingRequested": false
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/scheduled-callbacks/{task_id}/start-call",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant, "Idempotency-Key": idempotency_key},
  json={
  "contactPointRef": "phone-1",
  "recordingRequested": false
},
)

{
  "placed": true,
  "callId": 7001,
  "interactionId": 3001,
  "status": "DIAL_AUTHORIZED",
  "dialGrantRef": "grant-1f7c9a4b",
  "dialGrantExpiresAt": "2026-07-26T15: 06:00Z"
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "409",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "idempotency.request.in.flight",
  "errors": []
}