Variables

Update variables

Renames variables or changes their type or value.

Either every update is applied or none is.

patch/variables

Request

  • Base URL: https://api.dittowords.com/v2
  • URL: https://api.dittowords.com/v2/variables
  • Auth: API key in header Authorization

Request body

Example request

{
  "updates": [
    {
      "name": "user_name",
      "newName": "customer_name"
    },
    {
      "name": "help_link",
      "data": {
        "text": "Read the docs",
        "url": "https://dittowords.com/docs"
      }
    }
  ]
}

Response

Returns the variables that changed, and those already in the requested state

updatedstring[] required

Names of the variables that changed

unchangedstring[] required

Names of the variables that were already in the requested state

Example response

{
  "updated": [
    "customer_name"
  ],
  "unchanged": [
    "help_link"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.