Update a form question

PATCH /forms/{formId}/questions/{id}

Update a form question by its ID

Headers

Path parameters

  • formId string Required

    Minimum length is 1.

  • id string Required

    Minimum length is 1.

application/json

Body

Responses

PATCH /forms/{formId}/questions/{id}
curl \
 -X PATCH https://api.development.pexipengage.com/enterprises/acme/forms/123/questions/123 \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
 -H "Accept-Language: en *" \
 -d '{"defaultValue":"string","externalId":"ABCD1234","targetProperty":"string","required":true,"hidden":true,"inputType":"SELECT","validator":{"regex":"^.{8}","translations":{"errorMessage":[{"language":"en","value":"Lorem ipsum"}]}},"translations":{"label":[{"language":"en","value":"Lorem ipsum"}],"helpText":[{"language":"en","value":"Lorem ipsum"}],"placeholder":[{"language":"en","value":"Lorem ipsum"}]},"order":5,"answerOptions":[{"externalId":"ABCD1234","value":"string","translations":{"label":[{"language":"en","value":"Lorem ipsum"}]},"order":5}],"fetchConfigurationId":"123"}'
Request examples
# Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002
Accept-Language: en *

# Payload
{
  "defaultValue": "string",
  "externalId": "ABCD1234",
  "targetProperty": "string",
  "required": true,
  "hidden": true,
  "inputType": "SELECT",
  "validator": {
    "regex": "^.{8}",
    "translations": {
      "errorMessage": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ]
    }
  },
  "translations": {
    "label": [
      {
        "language": "en",
        "value": "Lorem ipsum"
      }
    ],
    "helpText": [
      {
        "language": "en",
        "value": "Lorem ipsum"
      }
    ],
    "placeholder": [
      {
        "language": "en",
        "value": "Lorem ipsum"
      }
    ]
  },
  "order": 5,
  "answerOptions": [
    {
      "externalId": "ABCD1234",
      "value": "string",
      "translations": {
        "label": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ]
      },
      "order": 5
    }
  ],
  "fetchConfigurationId": "123"
}
Response examples (200)
{
  "data": {
    "id": "123",
    "form": {
      "id": "123"
    },
    "fetchConfiguration": {
      "id": "123"
    },
    "order": 5,
    "defaultValue": "string",
    "externalId": "ABCD1234",
    "targetProperty": "string",
    "required": true,
    "hidden": true,
    "inputType": "SELECT",
    "validator": {
      "regex": "^.{8}",
      "errorMessage": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "translations": {
        "errorMessage": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ]
      }
    },
    "label": {
      "language": "en",
      "value": "Lorem ipsum"
    },
    "helpText": {
      "language": "en",
      "value": "Lorem ipsum"
    },
    "placeholder": {
      "language": "en",
      "value": "Lorem ipsum"
    },
    "createdAt": "2022-08-17T19:05:21.362Z",
    "updatedAt": "2022-08-17T19:05:21.362Z",
    "deletedAt": "2022-08-17T19:05:21.362Z",
    "answerOptions": [
      {
        "externalId": "ABCD1234",
        "value": "string",
        "label": {
          "language": "en",
          "value": "Lorem ipsum"
        },
        "order": 5,
        "createdAt": "2022-08-17T19:05:21.362Z",
        "updatedAt": "2022-08-17T19:05:21.362Z",
        "deletedAt": "2022-08-17T19:05:21.362Z",
        "translations": {
          "label": [
            {
              "language": "en",
              "value": "Lorem ipsum"
            }
          ]
        }
      }
    ],
    "translations": {
      "label": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ],
      "helpText": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ],
      "placeholder": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ]
    }
  }
}
Response examples (404)
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string"
    }
  ]
}
Response examples (422)
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string",
      "arguments": {}
    }
  ]
}