Skip to main content
DELETE
/
api
/
resources
/
{schemaDefinitionNameOrId}
/
batch
Batch Delete Resources
curl --request DELETE \
  --url https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/batch \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalIds": [],
  "cascade": false,
  "deleteAll": false,
  "dryRun": false
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "batchId": "<string>",
    "message": "<string>",
    "recordCount": 123,
    "schemaDefinitionId": "<string>"
  }
}

Headers

​
reach-tenant-id
string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Path Parameters

​
schemaDefinitionNameOrId
string
required

The name or id of the schema definition the resources belong to

Body

application/json
​
externalIds
string[]

Array of external IDs to delete. Required (non-empty) unless deleteAll is true.

​
cascade
boolean
default:false

When true, also deletes resources in other schemas that reference the deleted resources.

​
deleteAll
boolean
default:false

Must be true to delete ALL resources for the schema. Without cascade, any resource that is referenced by a resource in another schema is left in place (neither it nor the referencing resource is deleted). With cascade, referencing resources in other schemas are also deleted. externalIds must be empty or omitted when deleteAll is true.

​
dryRun
boolean
default:false

When true, returns a synchronous preview of what would be deleted without queueing the job or touching any data. Per-schema deletion counts and the number of resources that would be skipped due to references are included.

Response

Status 202 response

​
success
boolean
required
​
message
string
​
data
object