Create a new profile key

post/v1/profiles

Create a new profile key

Request

Body

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 255
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 1000
          },
          "metadata": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "name"
        ]
      }
    }
  }
}

Responses

201No description

Schema

Schema Structure

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "key": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "metadata": {
          "type": [
            "array",
            "null"
          ],
          "items": {}
        },
        "created_at": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "key",
        "name",
        "description",
        "metadata",
        "created_at"
      ]
    },
    "message": {
      "type": "string",
      "enum": [
        "Profile key created successfully"
      ]
    }
  },
  "required": [
    "success",
    "data",
    "message"
  ]
}

422No description

Schema

Schema Structure

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "VALIDATION_ERROR"
          ]
        },
        "message": {
          "type": "string",
          "enum": [
            "Validation failed"
          ]
        },
        "details": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "title": "MessageBag"
        }
      },
      "required": [
        "code",
        "message",
        "details"
      ]
    }
  },
  "required": [
    "success",
    "error"
  ]
}