Easy2257
API Reference

Cancel Collab Scene

POST /api/v1/collab-scenes/{sceneId}/cancel: cancel a pending scene. No refund.

No refund. Cancelling does not return the scene fee or the performer onboarding fees: they paid for record creation and for verification sessions that were already started. Only scenes still in pending_signatures can be cancelled, and only by the partner that created them.

POST
/api/v1/collab-scenes/{sceneId}/cancel

Authorization

BearerAuth
AuthorizationBearer <token>

Partner API key from partner.easy2257.com/api-keys. Only ez_live_ keys are accepted. A key beginning with ez_test_ is rejected with 403 and code TEST_MODE_UNAVAILABLE before any handler runs: there is no sandbox, and every handler writes production records, provisions real users, and sends real email. New partner accounts start with a test key, so create a live key before your first call.

In: header

Path Parameters

sceneId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://easy2257.com/api/v1/collab-scenes/cmd5r9a4t0001qz8hb6k2m3xd/cancel"
{
  "sceneId": "cmd5r9a4t0001qz8hb6k2m3xd",
  "status": "cancelled",
  "refunded": false
}
{
  "error": "email, externalUserId, and callbackUrl are required",
  "code": "missing_parameter",
  "field": "contentType"
}
{
  "error": "email, externalUserId, and callbackUrl are required",
  "code": "missing_parameter",
  "field": "contentType"
}
{
  "error": "email, externalUserId, and callbackUrl are required",
  "code": "missing_parameter",
  "field": "contentType"
}
{
  "error": "email, externalUserId, and callbackUrl are required",
  "code": "missing_parameter",
  "field": "contentType"
}
{
  "error": "email, externalUserId, and callbackUrl are required",
  "code": "missing_parameter",
  "field": "contentType"
}
{
  "error": "Too many requests. Please slow down.",
  "retryAfter": 14,
  "limit": 60,
  "remaining": 0,
  "reset": 1714000060000
}
{
  "error": "email, externalUserId, and callbackUrl are required",
  "code": "missing_parameter",
  "field": "contentType"
}