Skip to main content
POST
/
api
/
resources
/
{schemaDefinitionNameOrId}
/
batch
Batch Upload Resources
curl --request POST \
  --url https://api.embedreach.com/api/resources/{schemaDefinitionNameOrId}/batch \
  --header 'Content-Type: application/json' \
  --data '
{
  "resources": [
    {}
  ]
}
'
{
  "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 to upload the resources to

Query Parameters

​
onconflict
enum<string>
default:upsert

What to do if the resource already exists. upsert will merge new data with existing data (PATCH-like behavior), preserving existing fields not included in the request. Null values will delete fields. reject will throw an error if the resource already exists

Available options:
upsert,
reject
​
ignoreUnknownFields
boolean | null
default:false

Whether to allow extra fields that are not defined in the schema. If true, extra fields will be accepted but not saved. If false, requests with extra fields will be rejected.

​
dependencyWaitTimeout
integer | null
default:0

Timeout in seconds for storing resources with missing dependencies as pending. Dependencies refer to resources referenced via $ref fields in the schema definition. If 0 or not provided, resources with missing dependencies will be rejected. If > 0, resources with missing dependencies will be stored in pending state for the specified duration. Maximum value is 86400 seconds (24 hours).

Required range: 0 <= x <= 86400

Body

application/json
​
resources
object[]
required

An array of resources to upload

Response

Status 202 response

​
success
boolean
required
​
message
string
​
data
object