Fields

Update field

Changed on

Update a field definition.

Copy as Markdown Open in ChatGPT Open in Claude

put/v1/accounts/{accountId}/fields/{fieldId}

Request

  • Base URL
    https://api.assinafy.com.br
  • URL
    https://api.assinafy.com.br/v1/accounts/{accountId}/fields/{fieldId}
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Path parameters

accountIdstring required

Workspace account ID.

fieldIdstring required

The field ID.

Request body

namestring
regexstring nullable
is_activeboolean

Response

The updated field

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": {
    "resource": "field",
    "id": "6152120297080d55bdd13197",
    "name": "Signature",
    "type": "signature"
  }
}

Changes