Documentation by ClonePartner

Start typing to search.

API Reference

Save one job configuration value

View Markdown
PUT /api/jobs/{id}/config/{key}

Validates and persists one job_config key declared by the job snapshot. form values are objects keyed by field key; field_mapping values are arrays of { source_field, target_field, transform? }.

Operation IDsaveJobConfig

Authentication

  • BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

keystringrequired

Request body

This request body is required.

Content typeapplication/json

requestobject
1 property
valueunknownrequired

Persisted value for the widget. field_mapping → array of { source_field, target_field, transform? }; form → object keyed by field key.

Success response body

200Config value saved

Config value saved

Content typeapplication/json

responseobject
2 properties
okboolean
valueunknown

Stored value after any transform_expr is applied.

Error responses

400Validation error

Validation error

Content typeapplication/json

responseobject
2 properties
errorstring
Example
NOT_FOUND
messagestring
Example
Resource not found
Example response
{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input"
}

404Resource not found

Resource not found

Content typeapplication/json

responseobject
2 properties
errorstring
Example
NOT_FOUND
messagestring
Example
Resource not found
Example response
{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}