---
agentTools:
  projectIndex: https://docs.archisnapper.com/llms.txt
---

# Create remarks

This part of the API lets you manage your checklists

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "API Settings",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://app3.archisnapper.com/api/public/v1"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/remarks": {
      "post": {
        "summary": "Create remarks",
        "description": "This part of the API lets you manage your checklists",
        "operationId": "create-a-remark",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "auth_token"
                ],
                "properties": {
                  "auth_token": {
                    "type": "string",
                    "description": "Your authentication token."
                  },
                  "remark": {
                    "properties": {
                      "name_en": {
                        "type": "string",
                        "description": "Name of the remark in English. You must fill in at least one translated field for the remark name."
                      },
                      "name_nl": {
                        "type": "string",
                        "description": "Name of the remark in Dutch. You must fill in at least one translated field for the category name."
                      },
                      "name_fr": {
                        "type": "string",
                        "description": "Name of the remark in French. You must fill in at least one translated field for the category name."
                      },
                      "external_id": {
                        "type": "integer",
                        "description": "The external ID of the new remark",
                        "format": "int32"
                      }
                    },
                    "required": [
                      "name_en"
                    ],
                    "type": "object"
                  },
                  "checklist_id": {
                    "type": "integer",
                    "description": "The checklist ID to which you want to add a new remark",
                    "format": "int32"
                  },
                  "section_id": {
                    "type": "integer",
                    "description": "The section ID to which you want to add a new remark",
                    "format": "int32"
                  },
                  "check_id": {
                    "type": "integer",
                    "description": "The check ID to which you want to add a new remark",
                    "format": "int32"
                  },
                  "checklist_external_id": {
                    "type": "integer",
                    "description": "The external checklist ID to which you want to add a new remark",
                    "format": "int32"
                  },
                  "section_external_id": {
                    "type": "integer",
                    "description": "The external section ID to which you want to add a new remark",
                    "format": "int32"
                  },
                  "check_external_id": {
                    "type": "integer",
                    "description": "The external check ID to which you want to add a new remark",
                    "format": "int32"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"checklist_id\": 5025,\n    \"checklist_name\": \"checklist\",\n    \"checklist_external_id\": 1000011,\n    \"section\": {\n        \"id\": 30976,\n        \"name\": \"section\",\n        \"external_id\": 10000002,\n        \"position\": 0,\n        \"checks\": [\n            {\n                \"id\": 207364,\n                \"name\": \"check\",\n                \"external_id\": 5000004,\n                \"position\": 4,\n                \"remarks\": [\n                    {\n                        \"id\": 901666,\n                        \"name\": \"remark\",\n                        \"external_id\": 6000000\n                    }\n                ]\n            }\n        ]\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "checklist_id": {
                      "type": "integer",
                      "example": 5025,
                      "default": 0
                    },
                    "checklist_name": {
                      "type": "string",
                      "example": "checklist"
                    },
                    "checklist_external_id": {
                      "type": "integer",
                      "example": 1000011,
                      "default": 0
                    },
                    "section": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "integer",
                          "example": 30976,
                          "default": 0
                        },
                        "name": {
                          "type": "string",
                          "example": "section"
                        },
                        "external_id": {
                          "type": "integer",
                          "example": 10000002,
                          "default": 0
                        },
                        "position": {
                          "type": "integer",
                          "example": 0,
                          "default": 0
                        },
                        "checks": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "integer",
                                "example": 207364,
                                "default": 0
                              },
                              "name": {
                                "type": "string",
                                "example": "check"
                              },
                              "external_id": {
                                "type": "integer",
                                "example": 5000004,
                                "default": 0
                              },
                              "position": {
                                "type": "integer",
                                "example": 4,
                                "default": 0
                              },
                              "remarks": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "id": {
                                      "type": "integer",
                                      "example": 901666,
                                      "default": 0
                                    },
                                    "name": {
                                      "type": "string",
                                      "example": "remark"
                                    },
                                    "external_id": {
                                      "type": "integer",
                                      "example": 6000000,
                                      "default": 0
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "204": {
            "description": "204",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "422": {
            "description": "422",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"name\": [\n    \"can't be blank\"\n  ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "can't be blank"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "63053e399807941f67a925c7:5a817756da40f30031799df9"
}
```