API Reference›Servicing Plane›Interactions›Create an interaction

Create an interaction

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/interactions Bearer token · CREATE_INTERACTION

Creates, schedules, or executes an inbound/outbound interaction and rechecks channel eligibility at execution.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/interactions \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "caseId": "case_HBR_COL_51",
  "direction": "outbound",
  "channel": "voice",
  "purpose": "collections",
  "contactPointId": "cp_MAYA_MOBILE_1",
  "content": {
    "scriptVersion": "collections-opening-v5"
  }
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/interactions`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "caseId": "case_HBR_COL_51",
  "direction": "outbound",
  "channel": "voice",
  "purpose": "collections",
  "contactPointId": "cp_MAYA_MOBILE_1",
  "content": {
    "scriptVersion": "collections-opening-v5"
  }
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/interactions",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "caseId": "case_HBR_COL_51",
  "direction": "outbound",
  "channel": "voice",
  "purpose": "collections",
  "contactPointId": "cp_MAYA_MOBILE_1",
  "content": {
    "scriptVersion": "collections-opening-v5"
  }
},
)

{
  "interactionId": "int_HBR_CALL_91",
  "caseId": "case_HBR_COL_51",
  "direction": "outbound",
  "channel": "voice",
  "purpose": "collections",
  "status": "completed",
  "outcome": "verified_party_reached",
  "startedAt": "2027-05-01T10: 12: 03-07: 00"
}

{
  "type": "https://docs.lendeasy.ai/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "code": "forbidden",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/version_conflict",
  "title": "Version Conflict",
  "status": 409,
  "code": "version_conflict",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/validation_error",
  "title": "Validation Error",
  "status": 422,
  "code": "validation_error",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/rate_limited",
  "title": "Rate Limited",
  "status": 429,
  "code": "rate_limited",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

Path & query parameters

Field	Type	Description
Idempotency-Key required in header	string	Stable key for this one logical mutation. Reuse it for retries; reusing it with a different request returns 409.

Body parameters

Field	Type	Description
caseId required	string	Stable opaque servicing case identifier.
direction required	string
channel required	string
purpose required	string
contactPointId required	string
content required	object
scriptVersion	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/interactions \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "caseId": "case_HBR_COL_51",
  "direction": "outbound",
  "channel": "voice",
  "purpose": "collections",
  "contactPointId": "cp_MAYA_MOBILE_1",
  "content": {
    "scriptVersion": "collections-opening-v5"
  }
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/interactions`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "caseId": "case_HBR_COL_51",
  "direction": "outbound",
  "channel": "voice",
  "purpose": "collections",
  "contactPointId": "cp_MAYA_MOBILE_1",
  "content": {
    "scriptVersion": "collections-opening-v5"
  }
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/interactions",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "caseId": "case_HBR_COL_51",
  "direction": "outbound",
  "channel": "voice",
  "purpose": "collections",
  "contactPointId": "cp_MAYA_MOBILE_1",
  "content": {
    "scriptVersion": "collections-opening-v5"
  }
},
)

{
  "interactionId": "int_HBR_CALL_91",
  "caseId": "case_HBR_COL_51",
  "direction": "outbound",
  "channel": "voice",
  "purpose": "collections",
  "status": "completed",
  "outcome": "verified_party_reached",
  "startedAt": "2027-05-01T10: 12: 03-07: 00"
}

{
  "type": "https://docs.lendeasy.ai/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "code": "forbidden",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/version_conflict",
  "title": "Version Conflict",
  "status": 409,
  "code": "version_conflict",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/validation_error",
  "title": "Validation Error",
  "status": 422,
  "code": "validation_error",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/rate_limited",
  "title": "Rate Limited",
  "status": 429,
  "code": "rate_limited",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}