Fail Enrollment

post

Path parameters

idstringRequired

Body

application/jsontext/jsonapplication/*+json

Responses

200

OK

application/json

idstringOptional

applicableTostring · enumOptionalPossible values:

typestring · enumOptionalPossible values:

statusstring · enumOptionalPossible values:

notesstring · nullableOptional

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

post

/public/v1/program/enrollments/{id}/fail

HTTPcURLJavaScriptPython

POST /public/v1/program/enrollments/{id}/fail HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "statusNotes": {
    "id": "text",
    "message": "text",
    "parameters": null
  }
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-03-26T00:03:06.711Z",
      "by": {}
    },
    "updated": {
      "at": "2026-03-26T00:03:06.711Z",
      "by": {}
    },
    "processing": {
      "at": "2026-03-26T00:03:06.711Z",
      "by": {}
    },
    "querying": {
      "at": "2026-03-26T00:03:06.711Z",
      "by": {}
    },
    "completed": {
      "at": "2026-03-26T00:03:06.711Z",
      "by": {}
    },
    "failed": {
      "at": "2026-03-26T00:03:06.711Z",
      "by": {}
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "certificate": {
    "id": "text",
    "name": "text"
  },
  "program": {
    "id": "text",
    "name": "text",
    "status": "text",
    "applicableTo": "text",
    "products": [
      {
        "id": "text",
        "audit": {},
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "shortDescription": "text",
        "longDescription": "text",
        "externalIds": {
          "operations": "text",
          "defaultErpItem": "text"
        },
        "website": "text",
        "icon": "text",
        "status": "text",
        "vendor": {
          "id": "text",
          "icon": "text",
          "type": "text",
          "status": "text",
          "name": "text"
        },
        "settings": {
          "productOrdering": true,
          "productRequests": {
            "enabled": true,
            "name": "text",
            "label": "text"
          },
          "itemSelection": true,
          "orderQueueChanges": true,
          "preValidation": {
            "purchaseOrderDraft": true,
            "purchaseOrderQuerying": true,
            "changeOrderDraft": true,
            "configurationOrderDraft": true,
            "terminationOrder": true,
            "productRequest": true
          },
          "splitBilling": {
            "enabled": true,
            "type": "text"
          },
          "subscriptionCessation": {
            "enabled": true,
            "mode": "Termination"
          }
        },
        "statistics": {
          "itemCount": 1,
          "ordersPlacedCount": 1,
          "agreementCount": 1,
          "subscriptionCount": 1,
          "requestCount": 1
        }
      }
    ]
  },
  "applicableTo": "text",
  "type": "text",
  "buyer": {
    "id": "text",
    "icon": "text",
    "name": "text"
  },
  "licensee": {
    "id": "text",
    "icon": "text",
    "name": "text",
    "externalId": "text"
  },
  "eligibility": {
    "client": true,
    "partner": true
  },
  "status": "text",
  "notes": "text",
  "statusNotes": {
    "id": "text",
    "message": "text",
    "parameters": null
  },
  "assignee": {
    "id": "text",
    "icon": "text",
    "name": "text"
  },
  "parameters": {
    "ordering": [
      {
        "id": "text",
        "externalId": "text",
        "name": "text",
        "type": "text",
        "phase": "text",
        "error": {
          "id": "text",
          "message": "text",
          "parameters": null
        },
        "constraints": {
          "hidden": true,
          "readonly": true,
          "required": true
        },
        "displayValue": "text",
        "value": null
      }
    ],
    "fulfillment": [
      {
        "id": "text",
        "externalId": "text",
        "name": "text",
        "type": "text",
        "phase": "text",
        "error": {
          "id": "text",
          "message": "text",
          "parameters": null
        },
        "constraints": {
          "hidden": true,
          "readonly": true,
          "required": true
        },
        "displayValue": "text",
        "value": null
      }
    ]
  },
  "error": {
    "id": "text",
    "message": "text",
    "parameters": null
  },
  "template": {
    "id": "text",
    "name": "text",
    "type": "text"
  }
}