DatabasesUpdateUrlAttributeRequest
{
"type": "object",
"required": [
"required",
"default"
],
"properties": {
"default": {
"type": "string",
"x-example": "https://example.com",
"x-nullable": true,
"description": "Default value for attribute when not provided. Cannot be set when attribute is required."
},
"required": {
"type": "boolean",
"x-example": false,
"description": "Is attribute required?"
}
}
}
FunctionsCreateDeploymentFunctionCodeRequest
{
"type": "object",
"required": [
"code",
"activate"
],
"properties": {
"code": {
"type": "string",
"x-example": null,
"description": "Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory."
},
"activate": {
"type": "boolean",
"x-example": false,
"description": "Automatically activate the deployment when it is finished building."
},
"commands": {
"type": "string",
"x-example": "<COMMANDS>",
"description": "Build Commands."
},
"entrypoint": {
"type": "string",
"x-example": "<ENTRYPOINT>",
"description": "Entrypoint File."
}
}
}
FunctionsCreateNewFunctionRequest
{
"type": "object",
"required": [
"functionId",
"name",
"runtime"
],
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Function name. Max length: 128 chars."
},
"events": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "Events list. Maximum of 100 events are allowed."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled."
},
"execute": {
"type": "array",
"items": {
"type": "string"
},
"x-example": "[\"any\"]",
"description": "An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long."
},
"logging": {
"type": "boolean",
"x-example": false,
"description": "Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project."
},
"runtime": {
"enum": [
"node-14.5",
"node-16.0",
"node-18.0",
"node-19.0",
"node-20.0",
"node-21.0",
"php-8.0",
"php-8.1",
"php-8.2",
"php-8.3",
"ruby-3.0",
"ruby-3.1",
"ruby-3.2",
"ruby-3.3",
"python-3.8",
"python-3.9",
"python-3.10",
"python-3.11",
"python-3.12",
"deno-1.40",
"dart-2.15",
"dart-2.16",
"dart-2.17",
"dart-2.18",
"dart-3.0",
"dart-3.1",
"dart-3.3",
"dotnet-3.1",
"dotnet-6.0",
"dotnet-7.0",
"java-8.0",
"java-11.0",
"java-17.0",
"java-18.0",
"java-21.0",
"swift-5.5",
"swift-5.8",
"swift-5.9",
"kotlin-1.6",
"kotlin-1.8",
"kotlin-1.9",
"cpp-17",
"cpp-20",
"bun-1.0"
],
"type": "string",
"x-example": "node-14.5",
"description": "Execution runtime.",
"x-enum-keys": [],
"x-enum-name": null
},
"timeout": {
"type": "integer",
"x-example": 1,
"description": "Function maximum execution time in seconds."
},
"commands": {
"type": "string",
"x-example": "<COMMANDS>",
"description": "Build Commands."
},
"schedule": {
"type": "string",
"x-example": null,
"description": "Schedule CRON syntax."
},
"entrypoint": {
"type": "string",
"x-example": "<ENTRYPOINT>",
"description": "Entrypoint File. This path is relative to the \"providerRootDirectory\"."
},
"functionId": {
"type": "string",
"x-example": "<FUNCTION_ID>",
"description": "Function ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
},
"templateOwner": {
"type": "string",
"x-example": "<TEMPLATE_OWNER>",
"description": "The name of the owner of the template."
},
"installationId": {
"type": "string",
"x-example": "<INSTALLATION_ID>",
"description": "Appwrite Installation ID for VCS (Version Control System) deployment."
},
"providerBranch": {
"type": "string",
"x-example": "<PROVIDER_BRANCH>",
"description": "Production branch for the repo linked to the function."
},
"templateBranch": {
"type": "string",
"x-example": "<TEMPLATE_BRANCH>",
"description": "Production branch for the repo linked to the function template."
},
"providerSilentMode": {
"type": "boolean",
"x-example": false,
"description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests."
},
"templateRepository": {
"type": "string",
"x-example": "<TEMPLATE_REPOSITORY>",
"description": "Repository name of the template."
},
"providerRepositoryId": {
"type": "string",
"x-example": "<PROVIDER_REPOSITORY_ID>",
"description": "Repository ID of the repo linked to the function."
},
"providerRootDirectory": {
"type": "string",
"x-example": "<PROVIDER_ROOT_DIRECTORY>",
"description": "Path to function code in the linked repo."
},
"templateRootDirectory": {
"type": "string",
"x-example": "<TEMPLATE_ROOT_DIRECTORY>",
"description": "Path to function code in the template repo."
}
}
}
FunctionsCreateVariableRequest
{
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"key": {
"type": "string",
"x-example": "<KEY>",
"description": "Variable key. Max length: 255 chars."
},
"value": {
"type": "string",
"x-example": "<VALUE>",
"description": "Variable value. Max length: 8192 chars."
}
}
}
FunctionsTriggerExecutionRequest
{
"type": "object",
"properties": {
"body": {
"type": "string",
"x-example": "<BODY>",
"description": "HTTP body of execution. Default value is empty string."
},
"path": {
"type": "string",
"x-example": "<PATH>",
"description": "HTTP path of execution. Path can include query params. Default value is /"
},
"async": {
"type": "boolean",
"x-example": false,
"description": "Execute code in the background. Default value is false."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS"
],
"type": "string",
"x-example": "GET",
"description": "HTTP method of execution. Default value is GET.",
"x-enum-keys": [],
"x-enum-name": "ExecutionMethod"
},
"headers": {
"type": "object",
"x-example": "{}",
"description": "HTTP headers of execution. Defaults to empty."
}
}
}
FunctionsUpdateByIdRequest
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Function name. Max length: 128 chars."
},
"events": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "Events list. Maximum of 100 events are allowed."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled."
},
"execute": {
"type": "array",
"items": {
"type": "string"
},
"x-example": "[\"any\"]",
"description": "An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long."
},
"logging": {
"type": "boolean",
"x-example": false,
"description": "Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project."
},
"runtime": {
"enum": [
"node-14.5",
"node-16.0",
"node-18.0",
"node-19.0",
"node-20.0",
"node-21.0",
"php-8.0",
"php-8.1",
"php-8.2",
"php-8.3",
"ruby-3.0",
"ruby-3.1",
"ruby-3.2",
"ruby-3.3",
"python-3.8",
"python-3.9",
"python-3.10",
"python-3.11",
"python-3.12",
"deno-1.40",
"dart-2.15",
"dart-2.16",
"dart-2.17",
"dart-2.18",
"dart-3.0",
"dart-3.1",
"dart-3.3",
"dotnet-3.1",
"dotnet-6.0",
"dotnet-7.0",
"java-8.0",
"java-11.0",
"java-17.0",
"java-18.0",
"java-21.0",
"swift-5.5",
"swift-5.8",
"swift-5.9",
"kotlin-1.6",
"kotlin-1.8",
"kotlin-1.9",
"cpp-17",
"cpp-20",
"bun-1.0"
],
"type": "string",
"x-example": "node-14.5",
"description": "Execution runtime.",
"x-enum-keys": [],
"x-enum-name": null
},
"timeout": {
"type": "integer",
"x-example": 1,
"description": "Maximum execution time in seconds."
},
"commands": {
"type": "string",
"x-example": "<COMMANDS>",
"description": "Build Commands."
},
"schedule": {
"type": "string",
"x-example": null,
"description": "Schedule CRON syntax."
},
"entrypoint": {
"type": "string",
"x-example": "<ENTRYPOINT>",
"description": "Entrypoint File. This path is relative to the \"providerRootDirectory\"."
},
"installationId": {
"type": "string",
"x-example": "<INSTALLATION_ID>",
"description": "Appwrite Installation ID for VCS (Version Controle System) deployment."
},
"providerBranch": {
"type": "string",
"x-example": "<PROVIDER_BRANCH>",
"description": "Production branch for the repo linked to the function"
},
"providerSilentMode": {
"type": "boolean",
"x-example": false,
"description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests."
},
"providerRepositoryId": {
"type": "string",
"x-example": "<PROVIDER_REPOSITORY_ID>",
"description": "Repository ID of the repo linked to the function"
},
"providerRootDirectory": {
"type": "string",
"x-example": "<PROVIDER_ROOT_DIRECTORY>",
"description": "Path to function code in the linked repo."
}
}
}
FunctionsUpdateVariableByIdRequest
{
"type": "object",
"required": [
"key"
],
"properties": {
"key": {
"type": "string",
"x-example": "<KEY>",
"description": "Variable key. Max length: 255 chars."
},
"value": {
"type": "string",
"x-example": "<VALUE>",
"description": "Variable value. Max length: 8192 chars."
}
}
}
MessagingCreateApnsProviderRequest
{
"type": "object",
"required": [
"providerId",
"name"
],
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"teamId": {
"type": "string",
"x-example": "<TEAM_ID>",
"description": "APNS team ID."
},
"authKey": {
"type": "string",
"x-example": "<AUTH_KEY>",
"description": "APNS authentication key."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"sandbox": {
"type": "boolean",
"x-example": false,
"description": "Use APNS sandbox environment."
},
"bundleId": {
"type": "string",
"x-example": "<BUNDLE_ID>",
"description": "APNS bundle ID."
},
"authKeyId": {
"type": "string",
"x-example": "<AUTH_KEY_ID>",
"description": "APNS authentication key ID."
},
"providerId": {
"type": "string",
"x-example": "<PROVIDER_ID>",
"description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
}
}
}
MessagingCreateEmailMessageRequest
{
"type": "object",
"required": [
"messageId",
"subject",
"content"
],
"properties": {
"cc": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "Array of target IDs to be added as CC."
},
"bcc": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "Array of target IDs to be added as BCC."
},
"html": {
"type": "boolean",
"x-example": false,
"description": "Is content of type HTML"
},
"draft": {
"type": "boolean",
"x-example": false,
"description": "Is message a draft"
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "List of User IDs."
},
"topics": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "List of Topic IDs."
},
"content": {
"type": "string",
"x-example": "<CONTENT>",
"description": "Email Content."
},
"subject": {
"type": "string",
"x-example": "<SUBJECT>",
"description": "Email Subject."
},
"targets": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "List of Targets IDs."
},
"messageId": {
"type": "string",
"x-example": "<MESSAGE_ID>",
"description": "Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
},
"attachments": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "Array of compound bucket IDs to file IDs to be attached to the email."
},
"scheduledAt": {
"type": "string",
"x-example": null,
"description": "Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future."
}
}
}
MessagingCreateFcmProviderRequest
{
"type": "object",
"required": [
"providerId",
"name"
],
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"providerId": {
"type": "string",
"x-example": "<PROVIDER_ID>",
"description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
},
"serviceAccountJSON": {
"type": "object",
"x-example": "{}",
"description": "FCM service account JSON."
}
}
}
MessagingCreateMsg91ProviderRequest
{
"type": "object",
"required": [
"providerId",
"name"
],
"properties": {
"from": {
"type": "string",
"x-example": "+12065550100",
"description": "Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212."
},
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"authKey": {
"type": "string",
"x-example": "<AUTH_KEY>",
"description": "Msg91 Auth Key."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"senderId": {
"type": "string",
"x-example": "<SENDER_ID>",
"description": "Msg91 Sender ID."
},
"providerId": {
"type": "string",
"x-example": "<PROVIDER_ID>",
"description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
}
}
}
MessagingCreateProviderRequest
{
"type": "object",
"required": [
"providerId",
"name"
],
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"apiKey": {
"type": "string",
"x-example": "<API_KEY>",
"description": "Mailgun API Key."
},
"domain": {
"type": "string",
"x-example": "<DOMAIN>",
"description": "Mailgun Domain."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"fromName": {
"type": "string",
"x-example": "<FROM_NAME>",
"description": "Sender Name."
},
"fromEmail": {
"type": "string",
"x-example": "email@example.com",
"description": "Sender email address."
},
"isEuRegion": {
"type": "boolean",
"x-example": false,
"description": "Set as EU region."
},
"providerId": {
"type": "string",
"x-example": "<PROVIDER_ID>",
"description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
},
"replyToName": {
"type": "string",
"x-example": "<REPLY_TO_NAME>",
"description": "Name set in the reply to field for the mail. Default value is sender name. Reply to name must have reply to email as well."
},
"replyToEmail": {
"type": "string",
"x-example": "email@example.com",
"description": "Email set in the reply to field for the mail. Default value is sender email. Reply to email must have reply to name as well."
}
}
}
MessagingCreatePushNotificationRequest
{
"type": "object",
"required": [
"messageId",
"title",
"body"
],
"properties": {
"tag": {
"type": "string",
"x-example": "<TAG>",
"description": "Tag for push notification. Available only for Android Platform."
},
"body": {
"type": "string",
"x-example": "<BODY>",
"description": "Body for push notification."
},
"data": {
"type": "object",
"x-example": "{}",
"description": "Additional Data for push notification."
},
"icon": {
"type": "string",
"x-example": "<ICON>",
"description": "Icon for push notification. Available only for Android and Web Platform."
},
"badge": {
"type": "string",
"x-example": "<BADGE>",
"description": "Badge for push notification. Available only for IOS Platform."
},
"color": {
"type": "string",
"x-example": "<COLOR>",
"description": "Color for push notification. Available only for Android Platform."
},
"draft": {
"type": "boolean",
"x-example": false,
"description": "Is message a draft"
},
"image": {
"type": "string",
"x-example": "[ID1:ID2]",
"description": "Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage."
},
"sound": {
"type": "string",
"x-example": "<SOUND>",
"description": "Sound for push notification. Available only for Android and IOS Platform."
},
"title": {
"type": "string",
"x-example": "<TITLE>",
"description": "Title for push notification."
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "List of User IDs."
},
"action": {
"type": "string",
"x-example": "<ACTION>",
"description": "Action for push notification."
},
"topics": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "List of Topic IDs."
},
"targets": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "List of Targets IDs."
},
"messageId": {
"type": "string",
"x-example": "<MESSAGE_ID>",
"description": "Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
},
"scheduledAt": {
"type": "string",
"x-example": null,
"description": "Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future."
}
}
}
MessagingCreateSendgridProviderRequest
{
"type": "object",
"required": [
"providerId",
"name"
],
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"apiKey": {
"type": "string",
"x-example": "<API_KEY>",
"description": "Sendgrid API key."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"fromName": {
"type": "string",
"x-example": "<FROM_NAME>",
"description": "Sender Name."
},
"fromEmail": {
"type": "string",
"x-example": "email@example.com",
"description": "Sender email address."
},
"providerId": {
"type": "string",
"x-example": "<PROVIDER_ID>",
"description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
},
"replyToName": {
"type": "string",
"x-example": "<REPLY_TO_NAME>",
"description": "Name set in the reply to field for the mail. Default value is sender name."
},
"replyToEmail": {
"type": "string",
"x-example": "email@example.com",
"description": "Email set in the reply to field for the mail. Default value is sender email."
}
}
}
MessagingCreateSmsMessageRequest
{
"type": "object",
"required": [
"messageId",
"content"
],
"properties": {
"draft": {
"type": "boolean",
"x-example": false,
"description": "Is message a draft"
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "List of User IDs."
},
"topics": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "List of Topic IDs."
},
"content": {
"type": "string",
"x-example": "<CONTENT>",
"description": "SMS Content."
},
"targets": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "List of Targets IDs."
},
"messageId": {
"type": "string",
"x-example": "<MESSAGE_ID>",
"description": "Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
},
"scheduledAt": {
"type": "string",
"x-example": null,
"description": "Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future."
}
}
}
MessagingCreateSmtpProviderRequest
{
"type": "object",
"required": [
"providerId",
"name",
"host"
],
"properties": {
"host": {
"type": "string",
"x-example": "<HOST>",
"description": "SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465\"`. Hosts will be tried in order."
},
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"port": {
"type": "integer",
"x-example": 1,
"description": "The default SMTP server port."
},
"mailer": {
"type": "string",
"x-example": "<MAILER>",
"description": "The value to use for the X-Mailer header."
},
"autoTLS": {
"type": "boolean",
"x-example": false,
"description": "Enable SMTP AutoTLS feature."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"fromName": {
"type": "string",
"x-example": "<FROM_NAME>",
"description": "Sender Name."
},
"password": {
"type": "string",
"x-example": "<PASSWORD>",
"description": "Authentication password."
},
"username": {
"type": "string",
"x-example": "<USERNAME>",
"description": "Authentication username."
},
"fromEmail": {
"type": "string",
"x-example": "email@example.com",
"description": "Sender email address."
},
"encryption": {
"enum": [
"none",
"ssl",
"tls"
],
"type": "string",
"x-example": "none",
"description": "Encryption type. Can be omitted, 'ssl', or 'tls'",
"x-enum-keys": [],
"x-enum-name": "SmtpEncryption"
},
"providerId": {
"type": "string",
"x-example": "<PROVIDER_ID>",
"description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
},
"replyToName": {
"type": "string",
"x-example": "<REPLY_TO_NAME>",
"description": "Name set in the reply to field for the mail. Default value is sender name."
},
"replyToEmail": {
"type": "string",
"x-example": "email@example.com",
"description": "Email set in the reply to field for the mail. Default value is sender email."
}
}
}
MessagingCreateSubscriberRequest
{
"type": "object",
"required": [
"subscriberId",
"targetId"
],
"properties": {
"targetId": {
"type": "string",
"x-example": "<TARGET_ID>",
"description": "Target ID. The target ID to link to the specified Topic ID."
},
"subscriberId": {
"type": "string",
"x-example": "<SUBSCRIBER_ID>",
"description": "Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID."
}
}
}
MessagingCreateTelesignProviderRequest
{
"type": "object",
"required": [
"providerId",
"name"
],
"properties": {
"from": {
"type": "string",
"x-example": "+12065550100",
"description": "Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212."
},
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"apiKey": {
"type": "string",
"x-example": "<API_KEY>",
"description": "Telesign API key."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"customerId": {
"type": "string",
"x-example": "<CUSTOMER_ID>",
"description": "Telesign customer ID."
},
"providerId": {
"type": "string",
"x-example": "<PROVIDER_ID>",
"description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
}
}
}
MessagingCreateTextmagicProviderRequest
{
"type": "object",
"required": [
"providerId",
"name"
],
"properties": {
"from": {
"type": "string",
"x-example": "+12065550100",
"description": "Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212."
},
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"apiKey": {
"type": "string",
"x-example": "<API_KEY>",
"description": "Textmagic apiKey."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"username": {
"type": "string",
"x-example": "<USERNAME>",
"description": "Textmagic username."
},
"providerId": {
"type": "string",
"x-example": "<PROVIDER_ID>",
"description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
}
}
}
MessagingCreateTopicRequest
{
"type": "object",
"required": [
"topicId",
"name"
],
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Topic Name."
},
"topicId": {
"type": "string",
"x-example": "<TOPIC_ID>",
"description": "Topic ID. Choose a custom Topic ID or a new Topic ID."
},
"subscribe": {
"type": "array",
"items": {
"type": "string"
},
"x-example": "[\"any\"]",
"description": "An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long."
}
}
}
MessagingCreateTwilioProviderRequest
{
"type": "object",
"required": [
"providerId",
"name"
],
"properties": {
"from": {
"type": "string",
"x-example": "+12065550100",
"description": "Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212."
},
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"authToken": {
"type": "string",
"x-example": "<AUTH_TOKEN>",
"description": "Twilio authentication token."
},
"accountSid": {
"type": "string",
"x-example": "<ACCOUNT_SID>",
"description": "Twilio account secret ID."
},
"providerId": {
"type": "string",
"x-example": "<PROVIDER_ID>",
"description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
}
}
}
MessagingCreateVonageProviderRequest
{
"type": "object",
"required": [
"providerId",
"name"
],
"properties": {
"from": {
"type": "string",
"x-example": "+12065550100",
"description": "Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212."
},
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"apiKey": {
"type": "string",
"x-example": "<API_KEY>",
"description": "Vonage API key."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"apiSecret": {
"type": "string",
"x-example": "<API_SECRET>",
"description": "Vonage API secret."
},
"providerId": {
"type": "string",
"x-example": "<PROVIDER_ID>",
"description": "Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
}
}
}
MessagingUpdateApnsProviderRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"teamId": {
"type": "string",
"x-example": "<TEAM_ID>",
"description": "APNS team ID."
},
"authKey": {
"type": "string",
"x-example": "<AUTH_KEY>",
"description": "APNS authentication key."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"sandbox": {
"type": "boolean",
"x-example": false,
"description": "Use APNS sandbox environment."
},
"bundleId": {
"type": "string",
"x-example": "<BUNDLE_ID>",
"description": "APNS bundle ID."
},
"authKeyId": {
"type": "string",
"x-example": "<AUTH_KEY_ID>",
"description": "APNS authentication key ID."
}
}
}
MessagingUpdateEmailByIdRequest
{
"type": "object",
"properties": {
"cc": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "Array of target IDs to be added as CC."
},
"bcc": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "Array of target IDs to be added as BCC."
},
"html": {
"type": "boolean",
"x-example": false,
"description": "Is content of type HTML"
},
"draft": {
"type": "boolean",
"x-example": false,
"description": "Is message a draft"
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "List of User IDs."
},
"topics": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "List of Topic IDs."
},
"content": {
"type": "string",
"x-example": "<CONTENT>",
"description": "Email Content."
},
"subject": {
"type": "string",
"x-example": "<SUBJECT>",
"description": "Email Subject."
},
"targets": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "List of Targets IDs."
},
"scheduledAt": {
"type": "string",
"x-example": null,
"description": "Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future."
}
}
}
MessagingUpdateFcmProviderByIdRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"serviceAccountJSON": {
"type": "object",
"x-example": "{}",
"description": "FCM service account JSON."
}
}
}
MessagingUpdateMailgunProviderRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"apiKey": {
"type": "string",
"x-example": "<API_KEY>",
"description": "Mailgun API Key."
},
"domain": {
"type": "string",
"x-example": "<DOMAIN>",
"description": "Mailgun Domain."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"fromName": {
"type": "string",
"x-example": "<FROM_NAME>",
"description": "Sender Name."
},
"fromEmail": {
"type": "string",
"x-example": "email@example.com",
"description": "Sender email address."
},
"isEuRegion": {
"type": "boolean",
"x-example": false,
"description": "Set as EU region."
},
"replyToName": {
"type": "string",
"x-example": "<REPLY_TO_NAME>",
"description": "Name set in the reply to field for the mail. Default value is sender name."
},
"replyToEmail": {
"type": "string",
"x-example": "<REPLY_TO_EMAIL>",
"description": "Email set in the reply to field for the mail. Default value is sender email."
}
}
}
MessagingUpdateMsg91ProviderRequest
{
"type": "object",
"properties": {
"from": {
"type": "string",
"x-example": "<FROM>",
"description": "Sender number."
},
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"authKey": {
"type": "string",
"x-example": "<AUTH_KEY>",
"description": "Msg91 Auth Key."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"senderId": {
"type": "string",
"x-example": "<SENDER_ID>",
"description": "Msg91 Sender ID."
}
}
}
MessagingUpdateProviderByIdRequest
{
"type": "object",
"properties": {
"host": {
"type": "string",
"x-example": "<HOST>",
"description": "SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls://smtp1.example.com:587;ssl://smtp2.example.com:465\"`. Hosts will be tried in order."
},
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"port": {
"type": "integer",
"x-example": 1,
"description": "SMTP port."
},
"mailer": {
"type": "string",
"x-example": "<MAILER>",
"description": "The value to use for the X-Mailer header."
},
"autoTLS": {
"type": "boolean",
"x-example": false,
"description": "Enable SMTP AutoTLS feature."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"fromName": {
"type": "string",
"x-example": "<FROM_NAME>",
"description": "Sender Name."
},
"password": {
"type": "string",
"x-example": "<PASSWORD>",
"description": "Authentication password."
},
"username": {
"type": "string",
"x-example": "<USERNAME>",
"description": "Authentication username."
},
"fromEmail": {
"type": "string",
"x-example": "email@example.com",
"description": "Sender email address."
},
"encryption": {
"enum": [
"none",
"ssl",
"tls"
],
"type": "string",
"x-example": "none",
"description": "Encryption type. Can be 'ssl' or 'tls'",
"x-enum-keys": [],
"x-enum-name": "SmtpEncryption"
},
"replyToName": {
"type": "string",
"x-example": "<REPLY_TO_NAME>",
"description": "Name set in the Reply To field for the mail. Default value is Sender Name."
},
"replyToEmail": {
"type": "string",
"x-example": "<REPLY_TO_EMAIL>",
"description": "Email set in the Reply To field for the mail. Default value is Sender Email."
}
}
}
MessagingUpdateProviderRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"apiKey": {
"type": "string",
"x-example": "<API_KEY>",
"description": "Sendgrid API key."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"fromName": {
"type": "string",
"x-example": "<FROM_NAME>",
"description": "Sender Name."
},
"fromEmail": {
"type": "string",
"x-example": "email@example.com",
"description": "Sender email address."
},
"replyToName": {
"type": "string",
"x-example": "<REPLY_TO_NAME>",
"description": "Name set in the Reply To field for the mail. Default value is Sender Name."
},
"replyToEmail": {
"type": "string",
"x-example": "<REPLY_TO_EMAIL>",
"description": "Email set in the Reply To field for the mail. Default value is Sender Email."
}
}
}
MessagingUpdatePushNotificationRequest
{
"type": "object",
"properties": {
"tag": {
"type": "string",
"x-example": "<TAG>",
"description": "Tag for push notification. Available only for Android platforms."
},
"body": {
"type": "string",
"x-example": "<BODY>",
"description": "Body for push notification."
},
"data": {
"type": "object",
"x-example": "{}",
"description": "Additional Data for push notification."
},
"icon": {
"type": "string",
"x-example": "<ICON>",
"description": "Icon for push notification. Available only for Android and Web platforms."
},
"badge": {
"type": "integer",
"x-example": null,
"description": "Badge for push notification. Available only for iOS platforms."
},
"color": {
"type": "string",
"x-example": "<COLOR>",
"description": "Color for push notification. Available only for Android platforms."
},
"draft": {
"type": "boolean",
"x-example": false,
"description": "Is message a draft"
},
"image": {
"type": "string",
"x-example": "[ID1:ID2]",
"description": "Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage."
},
"sound": {
"type": "string",
"x-example": "<SOUND>",
"description": "Sound for push notification. Available only for Android and iOS platforms."
},
"title": {
"type": "string",
"x-example": "<TITLE>",
"description": "Title for push notification."
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "List of User IDs."
},
"action": {
"type": "string",
"x-example": "<ACTION>",
"description": "Action for push notification."
},
"topics": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "List of Topic IDs."
},
"targets": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "List of Targets IDs."
},
"scheduledAt": {
"type": "string",
"x-example": null,
"description": "Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future."
}
}
}
MessagingUpdateSmsMessageRequest
{
"type": "object",
"properties": {
"draft": {
"type": "boolean",
"x-example": false,
"description": "Is message a draft"
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "List of User IDs."
},
"topics": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "List of Topic IDs."
},
"content": {
"type": "string",
"x-example": "<CONTENT>",
"description": "Email Content."
},
"targets": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "List of Targets IDs."
},
"scheduledAt": {
"type": "string",
"x-example": null,
"description": "Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future."
}
}
}
MessagingUpdateTelesignProviderRequest
{
"type": "object",
"properties": {
"from": {
"type": "string",
"x-example": "<FROM>",
"description": "Sender number."
},
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"apiKey": {
"type": "string",
"x-example": "<API_KEY>",
"description": "Telesign API key."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"customerId": {
"type": "string",
"x-example": "<CUSTOMER_ID>",
"description": "Telesign customer ID."
}
}
}
MessagingUpdateTextmagicProviderRequest
{
"type": "object",
"properties": {
"from": {
"type": "string",
"x-example": "<FROM>",
"description": "Sender number."
},
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"apiKey": {
"type": "string",
"x-example": "<API_KEY>",
"description": "Textmagic apiKey."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"username": {
"type": "string",
"x-example": "<USERNAME>",
"description": "Textmagic username."
}
}
}
MessagingUpdateTopicByIdRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Topic Name."
},
"subscribe": {
"type": "array",
"items": {
"type": "string"
},
"x-example": "[\"any\"]",
"description": "An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long."
}
}
}
MessagingUpdateTwilioProviderRequest
{
"type": "object",
"properties": {
"from": {
"type": "string",
"x-example": "<FROM>",
"description": "Sender number."
},
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"authToken": {
"type": "string",
"x-example": "<AUTH_TOKEN>",
"description": "Twilio authentication token."
},
"accountSid": {
"type": "string",
"x-example": "<ACCOUNT_SID>",
"description": "Twilio account secret ID."
}
}
}
MessagingUpdateVonageProviderRequest
{
"type": "object",
"properties": {
"from": {
"type": "string",
"x-example": "<FROM>",
"description": "Sender number."
},
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Provider name."
},
"apiKey": {
"type": "string",
"x-example": "<API_KEY>",
"description": "Vonage API key."
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Set as enabled."
},
"apiSecret": {
"type": "string",
"x-example": "<API_SECRET>",
"description": "Vonage API secret."
}
}
}
StorageCreateFileRequest
{
"type": "object",
"required": [
"fileId",
"file"
],
"properties": {
"file": {
"type": "string",
"x-example": null,
"description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https://appwrite.io/docs/storage#file-input)."
},
"fileId": {
"type": "string",
"x-example": "<FILE_ID>",
"description": "File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
"x-upload-id": true
},
"permissions": {
"type": "array",
"items": {
"type": "string"
},
"x-example": "[\"read(\"any\")\"]",
"description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions)."
}
}
}
StorageCreateNewBucketRequest
{
"type": "object",
"required": [
"bucketId",
"name"
],
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Bucket name"
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled."
},
"bucketId": {
"type": "string",
"x-example": "<BUCKET_ID>",
"description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
},
"antivirus": {
"type": "boolean",
"x-example": false,
"description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled"
},
"encryption": {
"type": "boolean",
"x-example": false,
"description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled"
},
"compression": {
"enum": [
"none",
"gzip",
"zstd"
],
"type": "string",
"x-example": "none",
"description": "Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled",
"x-enum-keys": [],
"x-enum-name": null
},
"permissions": {
"type": "array",
"items": {
"type": "string"
},
"x-example": "[\"read(\"any\")\"]",
"description": "An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions)."
},
"fileSecurity": {
"type": "boolean",
"x-example": false,
"description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions)."
},
"maximumFileSize": {
"type": "integer",
"x-example": 1,
"description": "Maximum file size allowed in bytes. Maximum allowed value is 30MB."
},
"allowedFileExtensions": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long."
}
}
}
StorageUpdateBucketByIdRequest
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Bucket name"
},
"enabled": {
"type": "boolean",
"x-example": false,
"description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled."
},
"antivirus": {
"type": "boolean",
"x-example": false,
"description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled"
},
"encryption": {
"type": "boolean",
"x-example": false,
"description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled"
},
"compression": {
"enum": [
"none",
"gzip",
"zstd"
],
"type": "string",
"x-example": "none",
"description": "Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled",
"x-enum-keys": [],
"x-enum-name": null
},
"permissions": {
"type": "array",
"items": {
"type": "string"
},
"x-example": "[\"read(\"any\")\"]",
"description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions)."
},
"fileSecurity": {
"type": "boolean",
"x-example": false,
"description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions)."
},
"maximumFileSize": {
"type": "integer",
"x-example": 1,
"description": "Maximum file size allowed in bytes. Maximum allowed value is 30MB."
},
"allowedFileExtensions": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long."
}
}
}
StorageUpdateFileByIdRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Name of the file"
},
"permissions": {
"type": "array",
"items": {
"type": "string"
},
"x-example": "[\"read(\"any\")\"]",
"description": "An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions)."
}
}
}
TeamsCreateMembershipRequestRequest
{
"type": "object",
"required": [
"roles"
],
"properties": {
"url": {
"type": "string",
"x-example": "https://example.com",
"description": "URL to redirect the user back to your app from the invitation email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API."
},
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Name of the new team member. Max length: 128 chars."
},
"email": {
"type": "string",
"x-example": "email@example.com",
"description": "Email of the new team member."
},
"phone": {
"type": "string",
"x-example": "+12065550100",
"description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212."
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long."
},
"userId": {
"type": "string",
"x-example": "<USER_ID>",
"description": "ID of the user to be added to a team."
}
}
}
TeamsCreateNewTeamRequest
{
"type": "object",
"required": [
"teamId",
"name"
],
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "Team name. Max length: 128 chars."
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long."
},
"teamId": {
"type": "string",
"x-example": "<TEAM_ID>",
"description": "Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
}
}
}
TeamsUpdateMembershipRolesRequest
{
"type": "object",
"required": [
"roles"
],
"properties": {
"roles": {
"type": "array",
"items": {
"type": "string"
},
"x-example": null,
"description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long."
}
}
}
TeamsUpdateMembershipStatusRequest
{
"type": "object",
"required": [
"userId",
"secret"
],
"properties": {
"secret": {
"type": "string",
"x-example": "<SECRET>",
"description": "Secret key."
},
"userId": {
"type": "string",
"x-example": "<USER_ID>",
"description": "User ID."
}
}
}
TeamsUpdateNameByIdRequest
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "New team name. Max length: 128 chars."
}
}
}
TeamsUpdatePrefsByIdRequest
{
"type": "object",
"required": [
"prefs"
],
"properties": {
"prefs": {
"type": "object",
"x-example": "{}",
"description": "Prefs key-value JSON object."
}
}
}
UsersCreateArgon2UserRequest
{
"type": "object",
"required": [
"userId",
"email",
"password"
],
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "User name. Max length: 128 chars."
},
"email": {
"type": "string",
"x-example": "email@example.com",
"description": "User email."
},
"userId": {
"type": "string",
"x-example": "<USER_ID>",
"description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
},
"password": {
"type": "string",
"x-example": "password",
"description": "User password hashed using Argon2."
}
}
}
UsersCreateBcryptUserRequest
{
"type": "object",
"required": [
"userId",
"email",
"password"
],
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "User name. Max length: 128 chars."
},
"email": {
"type": "string",
"x-example": "email@example.com",
"description": "User email."
},
"userId": {
"type": "string",
"x-example": "<USER_ID>",
"description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
},
"password": {
"type": "string",
"x-example": "password",
"description": "User password hashed using Bcrypt."
}
}
}
UsersCreateMd5UserRequest
{
"type": "object",
"required": [
"userId",
"email",
"password"
],
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "User name. Max length: 128 chars."
},
"email": {
"type": "string",
"x-example": "email@example.com",
"description": "User email."
},
"userId": {
"type": "string",
"x-example": "<USER_ID>",
"description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
},
"password": {
"type": "string",
"x-example": "password",
"description": "User password hashed using MD5."
}
}
}
UsersCreateNewUserRequest
{
"type": "object",
"required": [
"userId"
],
"properties": {
"name": {
"type": "string",
"x-example": "<NAME>",
"description": "User name. Max length: 128 chars."
},
"email": {
"type": "string",
"x-example": "email@example.com",
"description": "User email."
},
"phone": {
"type": "string",
"x-example": "+12065550100",
"description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212."
},
"userId": {
"type": "string",
"x-example": "<USER_ID>",
"description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars."
},
"password": {
"type": "string",
"x-example": null,
"description": "Plain text user password. Must be at least 8 chars."
}
}
}