API REFERENCE · SCHEMA

Batch schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

All endpoints and schemas
idRequired
string

Format: uuid.

nameRequired
string
environmentRequired
string

Values: "sandbox", "production".

statusRequired
string

Values: "importing", "pending", "processing", "completed", "cancelled", "failed".

totalRequired
integer

Minimum: 0.

completedRequired
integer

Minimum: 0.

failedRequired
integer

Minimum: 0.

created_atRequired
string

Format: date-time.

cancelled_atRequired
string or null

May be null.

cancelled_at fields and rules

Allowed alternatives

  • string

    Format: date-time.

  • null

    May be null.