Update a saved fill config

PATCH

https://api.cloudraker.com/v1/fill/configs/:idOrSlug

PATCH

/v1/fill/configs/:idOrSlug

curl -X PATCH https://api.cloudraker.com/v1/fill/configs/idOrSlug \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "object": "string",
  "id": "string",
  "slug": "string",
  "name": "string",
  "capability": "string",
  "config": {
    "template": "string",
    "instructions": "string",
    "output": "flattened",
    "fields": [
      {
        "name": "string",
        "type": "string",
        "label": "string",
        "page": 1,
        "box": {
          "x": 1.1,
          "y": 1.1,
          "width": 1.1,
          "height": 1.1
        },
        "description": "string",
        "required": true,
        "options": [
          "string"
        ],
        "maxLength": 1,
        "multiline": true,
        "section": "string",
        "ignore": true
      }
    ],
    "templateHash": "string"
  },
  "updatedAt": "string"
}

Renames a saved fill config, updates its config, or both. Send at least one field.

A config patch deep-merges over the saved config: objects merge key by key, arrays and scalars replace. Keys you leave out keep their saved values.

Runs that already referenced it keep the configuration they were created with — the config is snapshotted onto each run.

Learn more: Fill capability

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idOrSlugstringRequired>=1 character

Request

This endpoint expects an object.

namestringOptional1-200 characters

configobjectOptional

Response

The updated config.

object"config"

idstring

slugstring

namestring

capability"fill"

configobject

updatedAtstringOptional

Errors

400

Bad Request Error

404

Not Found Error

429

Too Many Requests Error