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

# Create a checklist

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": {
    "/checklists": {
      "post": {
        "summary": "Create a checklist",
        "description": "This part of the API lets you manage your checklists",
        "operationId": "creating-a-checklist",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "auth_token"
                ],
                "properties": {
                  "auth_token": {
                    "type": "string",
                    "description": "Your authentication token."
                  },
                  "checklist": {
                    "properties": {
                      "name_en": {
                        "type": "string",
                        "description": "Name of the checklist in English. You must fill in at least one translated field for the checklist name."
                      },
                      "name_nl": {
                        "type": "string",
                        "description": "Name of the checklist in Dutch . You must fill in at least one translated field for the checklist name."
                      },
                      "name_fr": {
                        "type": "string",
                        "description": "Name of the checklist in French . You must fill in at least one translated field for the checklist name."
                      },
                      "external_id": {
                        "type": "string",
                        "description": "The ID of the checklist in your database"
                      }
                    },
                    "required": [
                      "name_en"
                    ],
                    "type": "object"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"name\": \"checklist NL\",\n    \"id\": 5026,\n    \"external_id\": 1000012,\n    \"sections\": []\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "example": "checklist NL"
                    },
                    "id": {
                      "type": "integer",
                      "example": 5026,
                      "default": 0
                    },
                    "external_id": {
                      "type": "integer",
                      "example": 1000012,
                      "default": 0
                    },
                    "sections": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {}
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "422",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"errors\": {\n        \"name\": [\n            \"can't be blank\"\n        ]\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "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:5a8158693479b4001de25887"
}
```