Create a condition for a content block

Creates a condition requiring progress on another block before this block unlocks. Scoped to your integration’s institution via Basic Auth credentials.

POST/content-blocks/{id}/conditions

Authorization

AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Path parameters

idstringrequired

Content block ID

Request body

requiredapplication/json

requiredBlockIdstringrequired

ID of the content block that must meet the condition.

min length 1

conditionTypestringrequired

Type of condition to evaluate

Allowed:SimpleDependencySurveyDataWorkbenchDataGradeData

conditionobjectrequired

Condition-specific data. SimpleDependency: { requiredStatus: string[] }. SurveyData: { questionId: string, optionIds: string[] }. WorkbenchData: { workbenchFileId: string, requiredStatus: string }. GradeData: { passed: boolean }.

Responses

201

Condition created

dataConditionrequired

Unlock condition on a content block. The block stays locked until the referenced requiredBlockId satisfies conditionType and condition.

Show properties

idstringrequired

Condition ID

blockIdstringrequired

Content block this condition belongs to

requiredBlockIdstringrequired

ID of the content block that must meet the condition.

conditionTypestringrequired

SimpleDependency: block must have a specific status. SurveyData: survey must have specific answers. WorkbenchData: workbench must meet criteria. GradeData: grade must meet criteria.

Allowed:SimpleDependencySurveyDataWorkbenchDataGradeData

conditionobjectrequired

Condition-specific data. Structure depends on conditionType.

requiredBlockobject

Show properties

idstring

namestring

typestring

metaResponseMetarequired

Show properties

requestIdstringrequired

timestampstring<date-time>required

versionstringrequired

Allowed:v4

400

Bad Request

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

401

Unauthorized

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

403

Forbidden

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

409

Conflict

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

429

Too Many Requests

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

500

Internal Server Error

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Basic auth usernameBasic auth password

Remember on this deviceInclude my values in samples

Parameters

idpath*Content block ID

Bodyapplication/json

Request body

Request

curl -X POST 'https://fuxam.app/api/v4/content-blocks/string/conditions' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Content-Type: application/json' \
  -d '{
  "requiredBlockId": "block_prev_xyz",
  "conditionType": "SimpleDependency",
  "condition": {
    "requiredStatus": [
      "FINISHED",
      "REVIEWED"
    ]
  }
}'

const response = await fetch("https://fuxam.app/api/v4/content-blocks/string/conditions", {
  method: "POST",
  headers: {
    "Authorization": "Basic YOUR_CREDENTIALS",
    "Content-Type": "application/json"
  },
  body: "{\n  \"requiredBlockId\": \"block_prev_xyz\",\n  \"conditionType\": \"SimpleDependency\",\n  \"condition\": {\n    \"requiredStatus\": [\n      \"FINISHED\",\n      \"REVIEWED\"\n    ]\n  }\n}"
});

import requests

response = requests.post(
    "https://fuxam.app/api/v4/content-blocks/string/conditions",
    headers={
        "Authorization": "Basic YOUR_CREDENTIALS",
        "Content-Type": "application/json"
    },
    data="{\n  \"requiredBlockId\": \"block_prev_xyz\",\n  \"conditionType\": \"SimpleDependency\",\n  \"condition\": {\n    \"requiredStatus\": [\n      \"FINISHED\",\n      \"REVIEWED\"\n    ]\n  }\n}",
)

Response

{
  "data": {
    "id": "string",
    "blockId": "string",
    "requiredBlockId": "string",
    "conditionType": "SimpleDependency",
    "condition": {},
    "requiredBlock": {
      "id": "string",
      "name": "string",
      "type": "string"
    }
  },
  "meta": {
    "requestId": "req_1234567890_abc",
    "timestamp": "2026-06-02T07:00:00.000Z",
    "version": "v4"
  }
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}