Adding Data

Add Data to a Bloc

Adds a new record to a Blocworx bloc.

POST https://example.mydomain.com/api/add-data

---

Request Body

Name	Type	Description
scanStationID*	string	The bloc ID to add data to. This may be a UUID depending on your instance.
jobID	string	The module ID associated with the bloc. This may be required depending on your instance or workflow.
dataToAdd*	string	A JSON-encoded string containing the field slugs and values to add. Example: "{\"field_1\":\"Test\",\"field_2\":\"123\"}"

---

Request Notes

• dataToAdd should be sent as a JSON string

• This endpoint supports file-related workflows, so some clients may also use multipart/form-data

• For text-only submissions, raw JSON requests are supported

---

200 Success Response

{
  "returnedStationID": 123456,
  "autogenerateReplacements": []
}

Response Notes

• returnedStationID is the created data entry ID

• autogenerateReplacements contains any auto-generated replacement values produced by the submission flow

---

Error Responses

403 Forbidden

{
  "error": "You do not have permission to add or edit data on this form."
}

400 Bad Request

{
  "error": "Error message"
}

In the current implementation, some 400 responses may also include debug fields such as line, file, and trace.

---

Example Requests

JSON Request

curl --request POST 'https://example.mydomain.com/api/add-data' \
  --header 'Authorization: Bearer [AUTHTOKEN]' \
  --header 'Content-Type: application/json' \
  --data '{
    "scanStationID": "a1489634-4009-4cc0-8a65-9965f5a1bea7",
    "jobID": "a148961d-236f-4b7e-9ac4-bfc9b729b0d6",
    "dataToAdd": "{\"field_number_1\":\"ADD_TEST\",\"field_number_2\":\"123\",\"radio_name\":\"1\"}"
  }'

JavaScript

fetch('https://example.mydomain.com/api/add-data', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer [AUTHTOKEN]',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    scanStationID: 'a1489634-4009-4cc0-8a65-9965f5a1bea7',
    jobID: 'a148961d-236f-4b7e-9ac4-bfc9b729b0d6',
    dataToAdd: JSON.stringify({
      field_number_1: 'ADD_TEST',
      field_number_2: '123',
      radio_name: '1'
    })
  })
})
.then(res => res.json())
.then(data => console.log(data));

Python

import requests
import json

url = "https://example.mydomain.com/api/add-data"

payload = {
    "scanStationID": "a1489634-4009-4cc0-8a65-9965f5a1bea7",
    "jobID": "a148961d-236f-4b7e-9ac4-bfc9b729b0d6",
    "dataToAdd": json.dumps({
        "field_number_1": "ADD_TEST",
        "field_number_2": "123",
        "radio_name": "1"
    })
}

headers = {
    "Authorization": "Bearer [AUTHTOKEN]",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)