Architect Flow DEPLOY_PIPELINE failing - Missing SCHEMA_VERSION?!

NICE CXone API & Integrations
1

Hi all! We’re hitting a snag with our DEPLOY_PIPELINE - it’s failing on a FLOW update and I’m a bit puzzled. It looks like the platform is expecting a SCHEMA_VERSION in the payload, but it’s not being included by the SDK. :exploding_head:

The error we’re getting back when updating the flow version is a 400 BAD_REQUEST with this message: “SCHEMA_VERSION is required”. The SDK version we’re using is 4.2.1.

This is happening when we’re trying to update a TRANSFER_BLOCK within the IVR. It seems like the SDK isn’t automatically including the SCHEMA_VERSION with the updated flow definition - which is super strange. We’ve checked the documentation, and it doesn’t explicitly mention needing to manually add the SCHEMA_VERSION for a DEPLOY_PIPELINE.

Here’s a snippet of the payload we’re building - it’s missing the SCHEMA_VERSION, clearly:

{
 "name": "Main IVR Flow",
 "description": "Handles initial call routing",
 "rootNode": {
 "type": "TRANSFER_BLOCK",
 "configuration": {
 "targetFlowId": "flow_12345"
 }
 }
}

Anyone else run into this? Is there a setting I’m missing, or is this something we have to manually tack onto the payload before sending it?

2
  • That’s right, the schema version is needed. We’ve seen this too - it’s missing from the generated payloads sometimes.
  • Try adding this to your Terraform:
 flow.schema_version = "1.0" # or whatever version you're using
  • Is the flow you’re updating a new flow, or an existing one? If existing, maybe the schema version isn’t changing, but it still needs to be in the payload.
1 Like