> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zype.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Zobject

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Zobjects",
    "version": "1.0.0",
    "description": ""
  },
  "servers": [
    {
      "url": "https://api.zype.com/"
    }
  ],
  "security": [
    {
      "api_key": []
    }
  ],
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "api_key",
        "in": "query"
      }
    }
  },
  "paths": {
    "/zobjects": {
      "post": {
        "summary": "Create Zobject",
        "description": "",
        "tags": [
          "Zobjects"
        ],
        "operationId": "createZobject",
        "parameters": [
          {
            "name": "Content-Type",
            "in": "header",
            "schema": {
              "type": "string",
              "enum": [
                "application/json",
                "multipart/form-data"
              ]
            },
            "description": "Specify the request content type (Default: application/json)"
          }
        ],
        "requestBody": {
          "description": "",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "title": "ZobjectRequest",
                "type": "object",
                "required": [
                  "zobject_type",
                  "zobject"
                ],
                "properties": {
                  "zobject_type": {
                    "type": "string",
                    "description": "The type of Zobject"
                  },
                  "zobject": {
                    "type": "object",
                    "title": "Zobject Properties",
                    "properties": {
                      "active": {
                        "type": "boolean",
                        "description": "Indicates if the Zobject is active"
                      },
                      "custom": {
                        "type": "string",
                        "description": "Custom attributes for the zobject (Example: `zobject[custom][color]=blue`)"
                      },
                      "description": {
                        "type": "string"
                      },
                      "friendly_title": {
                        "type": "string",
                        "description": "The friendly title of the zobject"
                      },
                      "keywords": {
                        "type": "array",
                        "description": "Keywords for the zobject"
                      },
                      "title": {
                        "type": "string"
                      },
                      "pictures_attributes": {
                        "type": "array",
                        "description": "An indexed collection specifying the pictures attributes for the zobject",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "ID of the zobject picture. Needed in case of update"
                            },
                            "title": {
                              "type": "string",
                              "description": "Title of the zobject picture"
                            },
                            "caption": {
                              "type": "string",
                              "description": "caption of the zobject picture"
                            },
                            "attachment": {
                              "type": "string",
                              "format": "binary",
                              "description": "File Attachment of the zobject picture (Only supported in requests with content-type multipart/form-data)"
                            },
                            "_destroy": {
                              "type": "boolean",
                              "description": "True if you want to remove the picture from the zobject"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "title": "ZobjectResponse",
                  "type": "object",
                  "properties": {
                    "response": {
                      "title": "Zobject",
                      "type": "object",
                      "properties": {
                        "_id": {
                          "type": "string"
                        },
                        "created_at": {
                          "type": "string"
                        },
                        "site_id": {
                          "type": "string"
                        },
                        "updated_at": {
                          "type": "string"
                        },
                        "video_ids": {
                          "type": "array"
                        },
                        "playlist_ids": {
                          "type": "array"
                        },
                        "zobject_type_id": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "friendly_title": {
                          "type": "string"
                        },
                        "keywords": {
                          "type": "array"
                        },
                        "active": {
                          "type": "string"
                        },
                        "zobject_type_title": {
                          "type": "string"
                        },
                        "pictures": {
                          "type": "array",
                          "description": "An indexed collection specifying the pictures attributes for the zobject",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "ID of the zobject picture. Needed in case of update"
                              },
                              "title": {
                                "type": "string",
                                "description": "Title of the zobject picture"
                              },
                              "caption": {
                                "type": "string",
                                "description": "caption of the zobject picture"
                              },
                              "url": {
                                "type": "string",
                                "description": "URL of the Picture attachment"
                              },
                              "content_type": {
                                "type": "string",
                                "description": "Picture content type"
                              },
                              "updated_at": {
                                "type": "string",
                                "description": "Timestamp the image was updated",
                                "example": "2025-02-04T12:20:30.236-05:00"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Unprocessable Entity",
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```