API Error Response

Overview

This document summarizes the list of validation errors that can be set in content definitions. Each response includes the following fields: code, message, and field.

• code: A string representing the error type code (e.g., invalid for invalid request parameters)
• message: Standard error message for Kuroco
• field: The request parameter where the error occurred; not outputted for general errors

note

This reference contains validation errors set in content definitions. If there is a problem with the request, a different error will occur.

List of Validation Errors

Common

Condition	HTTP Status	Code	Message
Required Check	400	required	[item name] is required

Title

Condition	HTTP Status	Code	Field	Message
Input Restriction (E-mail)	400	invalid	subject	Invalid Text Please enter in a E-mail format.
Input Restriction (Phone Number)	400	invalid	subject	Invalid Text Please enter in a Contact number format.
Input Restriction (Postal Code)	400	invalid	subject	Invalid Text Please enter in a ZIP code format.
Input Restriction (URL)	400	invalid	subject	Invalid Title. Please enter in a URL format.
Input Restriction (Number)	400	invalid	subject	Invalid Title. Please enter in a Numeric value format.
Input Restriction (Regular Expression)	400	invalid	subject	Invalid Title
Input Restriction (Minimum Character Count)	400	invalid	subject	Title should be X characters or more.
Input Restriction (Maximum Character Count)	400	invalid	subject	Please input Title within X characters.

Single-line text

Condition	HTTP Status	Code	Field	Message
Input Restriction (E-mail)	400	invalid	ext_x	Invalid [item name]. Please enter in a E-mail format.
Input Restriction (Phone Number)	400	invalid	ext_x	Invalid [item name]. Please enter in a Contact number format.
Input Restriction (Postal Code)	400	invalid	ext_x	Invalid [item name]. Please enter in a ZIP code format.
Input Restriction (URL)	400	invalid	ext_x	Invalid [item name]. Please enter in a URL format.
Input Restriction (Number)	400	invalid	ext_x	Invalid [item name]. Please enter in a Numeric value format.
Input Restriction (Regular Expression)	400	invalid	ext_x	Invalid [item name]
Input Restriction (Minimum Character Count)	400	invalid	ext_x	Invalid The Number of characters of [item name]
Input Restriction (Maximum Character Count)	400	invalid	ext_x	Invalid The Number of characters of [item name]

Multi-line text

Condition	HTTP Status	Code	Field	Message
Input Restriction (Minimum Character Count)	400	invalid	ext_x	Invalid The Number of characters of [item name]
Input Restriction (Maximum Character Count)	400	invalid	ext_x	Invalid The Number of characters of [item name]

Image (uploaded to KurocoFiles)

Condition	HTTP Status	Code	Field	Message
Input restriction (file extension)	400	invalid	ext_x	Invalid [item name][File name]
Input restriction (file size limit)	400	invalid	ext_x	[Item name] Could not upload: the file size is too big

File (uploaded to KurocoFiles)

Condition	HTTP Status	Code	Field	Message
Input restriction (file extension)	400	invalid	ext_x	Invalid [item name][File name]
Input restriction (file size limit)	400	invalid	ext_x	[Item name] Could not upload: the file size is too big

File (uploaded to GCS)

Condition	HTTP Status	Code	Field	Message
Input restriction (file extension)	400	invalid	ext_x	Invalid [item name][File name]

File (uploaded to S3)

Condition	HTTP Status	Code	Field	Message
Input restriction (file extension)	400	invalid	ext_x	Invalid [item name][File name]

Error Response Sample

The error response sample for when the subject is empty or not specified in the content addition API is as follows:

{
  "errors": [
    {
      "code": "invalid",
      "message": "Title is required.",
      "field": "subject"
    }
  ],
  "x-rcms-request-id": "280496b2-8b45-4a9a-8a21-678feb77e2ff"
}

• If the error is specific to a certain field, the field will contain the name of the target field.