---
agentTools:
  projectIndex: https://docs.agilite.io/llms.txt
---

# /data

Creates a new Numbering profile in Agilit-e

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Agilit-e Numbering",
    "version": "7"
  },
  "servers": [
    {
      "url": "https://api.agilite.io/numbering"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "api-key"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/data": {
      "post": {
        "summary": "/data",
        "description": "Creates a new Numbering profile in Agilit-e",
        "operationId": "data-3",
        "parameters": [
          {
            "name": "Content-Type",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "default": "application/json"
            }
          },
          {
            "name": "log-profile-key",
            "in": "header",
            "description": "Profile Key of the Batch Logging Profile configured for logging",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "data": {
                    "properties": {
                      "isActive": {
                        "type": "boolean",
                        "description": "Set to \"true\" if profile is active and should be retrievable via API",
                        "default": true
                      },
                      "key": {
                        "type": "string",
                        "description": "A unique key for your Profile (e.g. po_number)"
                      },
                      "name": {
                        "type": "string",
                        "description": "A short name for the profile (e.g. Purchase Order Number)"
                      },
                      "description": {
                        "type": "string",
                        "description": "A detailed description explaining the profile (e.g. This is a PO Number)"
                      },
                      "groupName": {
                        "type": "string",
                        "description": "Group together profiles using a Group Name (e.g. Internal)"
                      },
                      "prefix": {
                        "type": "string",
                        "description": "A prefix for the number to be generated (e.g. PO)"
                      },
                      "suffix": {
                        "type": "string",
                        "description": "A suffix for the number to be generated (e.g. _Active)"
                      },
                      "startAt": {
                        "type": "integer",
                        "description": "The starting point for the number that gets generated",
                        "default": 1,
                        "format": "int32"
                      },
                      "incrementBasedOn": {
                        "type": "string",
                        "description": "1=Prefix/2=Suffix/3=Both"
                      },
                      "minLength": {
                        "type": "integer",
                        "description": "The minimum length of the number to be generated (e.g. 3=001, 4=0001, etc.)",
                        "default": 3,
                        "format": "int32"
                      }
                    },
                    "required": [
                      "key",
                      "name"
                    ],
                    "type": "object"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"_id\": \"001\",\n    \"createdBy\": \"user\",\n    \"modifiedBy\": \"user\",\n    \"data\": {\n        \"isActive\": true,\n        \"key\": \"key1\",\n        \"name\": \"Name1\",\n        \"description\": \"description\",\n        \"groupName\": \"Group 1\",\n        \"prefix\": \"\",\n        \"suffix\": \"\",\n        \"startAt\": 1,\n        \"incrementBasedOn\": \"3\",\n        \"minLength\": 1\n    },\n    \"createdAt\": \"\",\n    \"updatedAt\": \"\",\n    \"__v\": 0\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "_id": {
                      "type": "string",
                      "example": "001"
                    },
                    "createdBy": {
                      "type": "string",
                      "example": "user"
                    },
                    "modifiedBy": {
                      "type": "string",
                      "example": "user"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "isActive": {
                          "type": "boolean",
                          "example": true,
                          "default": true
                        },
                        "key": {
                          "type": "string",
                          "example": "key1"
                        },
                        "name": {
                          "type": "string",
                          "example": "Name1"
                        },
                        "description": {
                          "type": "string",
                          "example": "description"
                        },
                        "groupName": {
                          "type": "string",
                          "example": "Group 1"
                        },
                        "prefix": {
                          "type": "string",
                          "example": ""
                        },
                        "suffix": {
                          "type": "string",
                          "example": ""
                        },
                        "startAt": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        },
                        "incrementBasedOn": {
                          "type": "string",
                          "example": "3"
                        },
                        "minLength": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        }
                      }
                    },
                    "createdAt": {
                      "type": "string",
                      "example": ""
                    },
                    "updatedAt": {
                      "type": "string",
                      "example": ""
                    },
                    "__v": {
                      "type": "integer",
                      "example": 0,
                      "default": 0
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"statusCode\": 400,\n    \"errorMessage\": \"An Error Occurred\",\n    \"additionalMessages\": [\"An Error Occured\"]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "statusCode": {
                      "type": "integer",
                      "example": 400,
                      "default": 0
                    },
                    "errorMessage": {
                      "type": "string",
                      "example": "An Error Occurred"
                    },
                    "additionalMessages": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "An Error Occured"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "5fc0c5ba525f16005dcefb93:5fc0c5ba525f16005dcefbc6"
}
```