Skip to content
post

Create boolean attribute

Endpoint

posthttps://<REGION>.cloud.appwrite.io...s/{collectionId}/attributes/boolean

Description

Create a boolean attribute.

Required scopes

collections.write

Authentication

Initialize the Appwrite client with setProject() and a server API key (setKey()). For direct REST calls, send X-Appwrite-Project and X-Appwrite-Key.

Path

string
Required

Database ID.

string
Required

Collection ID. You can create a new collection using the Database service server integration.

Body

string
Required

Attribute Key.

boolean
Required

Is attribute required?

boolean

Default value for attribute when not provided. Cannot be set when attribute is required.

boolean

Is attribute an array?

Status
Content type
202
application/json

AttributeBoolean

Name
Type
Description
string

Attribute Key.

string

Attribute type.

string

Attribute status. Possible values: available, processing, deleting, stuck, or failed

string

Error message. Displays error generated on failure of creating or deleting an attribute.

boolean

Is attribute required?

boolean

Is attribute an array?

boolean

Default value for attribute when not provided. Cannot be set when attribute is required.

GraphQL
mutation {
    databasesCreateBooleanAttribute(
        databaseId: "[DATABASE_ID]",
        collectionId: "[COLLECTION_ID]",
        key: "",
        required: false
    ) {
        key
        type
        status
        error
        required
    }
}