Go to Console
Star on GitHub 45.1K Get started

Messaging

SERVER

Appwrite Messaging helps you communicate with your users through push notifications, emails, and SMS text messages. Sending personalized communication for marketing, updates, and realtime alerts can increase user engagement and retention. You can also use Appwrite Messaging to implement security checks and custom authentication flows.

You can find guides and examples on using the Messaging API in the Appwrite Messaging product pages.

Base URL
https://cloud.appwrite.io/v1

List messages

Get a list of all messages from the current Appwrite project.

  • Request
    • queries array

      Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: scheduledAt, deliveredAt, deliveredTotal, status, description, providerType

    • search string

      Search term to filter your list results. Max length: 256 chars.

  • Response
Endpoint
GET /messaging/messages
REST
GET /v1/messaging/messages HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

Create email

Create a new email message.

  • Request
    • messageId string
      required

      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.

    • subject string
      required

      Email Subject.

    • content string
      required

      Email Content.

    • topics array

      List of Topic IDs.

    • users array

      List of User IDs.

    • targets array

      List of Targets IDs.

    • cc array

      Array of target IDs to be added as CC.

    • bcc array

      Array of target IDs to be added as BCC.

    • attachments array

      Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.

    • draft boolean

      Is message a draft

    • html boolean

      Is content of type HTML

    • scheduledAt string

      Scheduled delivery time for message in ISO 8601 format. DateTime value must be in future.

  • Response
Endpoint
POST /messaging/messages/email
REST
POST /v1/messaging/messages/email HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "messageId": "<MESSAGE_ID>",
  "subject": "<SUBJECT>",
  "content": "<CONTENT>",
  "topics": [],
  "users": [],
  "targets": [],
  "cc": [],
  "bcc": [],
  "attachments": [],
  "draft": false,
  "html": false,
  "scheduledAt": 
}

Update email

Update an email message by its unique ID.

  • Request
    • messageId string
      required

      Message ID.

    • topics array

      List of Topic IDs.

    • users array

      List of User IDs.

    • targets array

      List of Targets IDs.

    • subject string

      Email Subject.

    • content string

      Email Content.

    • draft boolean

      Is message a draft

    • html boolean

      Is content of type HTML

    • cc array

      Array of target IDs to be added as CC.

    • bcc array

      Array of target IDs to be added as BCC.

    • scheduledAt string

      Scheduled delivery time for message in ISO 8601 format. DateTime value must be in future.

    • attachments array

      Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.

  • Response
Endpoint
PATCH /messaging/messages/email/{messageId}
REST
PATCH /v1/messaging/messages/email/{messageId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "topics": [],
  "users": [],
  "targets": [],
  "subject": "<SUBJECT>",
  "content": "<CONTENT>",
  "draft": false,
  "html": false,
  "cc": [],
  "bcc": [],
  "scheduledAt": ,
  "attachments": []
}

Create push notification

Create a new push notification.

  • Request
    • messageId string
      required

      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.

    • title string
      required

      Title for push notification.

    • body string
      required

      Body for push notification.

    • topics array

      List of Topic IDs.

    • users array

      List of User IDs.

    • targets array

      List of Targets IDs.

    • data object

      Additional Data for push notification.

    • action string

      Action for push notification.

    • image string

      Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.

    • icon string

      Icon for push notification. Available only for Android and Web Platform.

    • sound string

      Sound for push notification. Available only for Android and IOS Platform.

    • color string

      Color for push notification. Available only for Android Platform.

    • tag string

      Tag for push notification. Available only for Android Platform.

    • badge string

      Badge for push notification. Available only for IOS Platform.

    • draft boolean

      Is message a draft

    • scheduledAt string

      Scheduled delivery time for message in ISO 8601 format. DateTime value must be in future.

  • Response
Endpoint
POST /messaging/messages/push
REST
POST /v1/messaging/messages/push HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "messageId": "<MESSAGE_ID>",
  "title": "<TITLE>",
  "body": "<BODY>",
  "topics": [],
  "users": [],
  "targets": [],
  "data": {},
  "action": "<ACTION>",
  "image": "[ID1:ID2]",
  "icon": "<ICON>",
  "sound": "<SOUND>",
  "color": "<COLOR>",
  "tag": "<TAG>",
  "badge": "<BADGE>",
  "draft": false,
  "scheduledAt": 
}

Update push notification

Update a push notification by its unique ID.

  • Request
    • messageId string
      required

      Message ID.

    • topics array

      List of Topic IDs.

    • users array

      List of User IDs.

    • targets array

      List of Targets IDs.

    • title string

      Title for push notification.

    • body string

      Body for push notification.

    • data object

      Additional Data for push notification.

    • action string

      Action for push notification.

    • image string

      Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.

    • icon string

      Icon for push notification. Available only for Android and Web platforms.

    • sound string

      Sound for push notification. Available only for Android and iOS platforms.

    • color string

      Color for push notification. Available only for Android platforms.

    • tag string

      Tag for push notification. Available only for Android platforms.

    • badge integer

      Badge for push notification. Available only for iOS platforms.

    • draft boolean

      Is message a draft

    • scheduledAt string

      Scheduled delivery time for message in ISO 8601 format. DateTime value must be in future.

  • Response
Endpoint
PATCH /messaging/messages/push/{messageId}
REST
PATCH /v1/messaging/messages/push/{messageId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "topics": [],
  "users": [],
  "targets": [],
  "title": "<TITLE>",
  "body": "<BODY>",
  "data": {},
  "action": "<ACTION>",
  "image": "[ID1:ID2]",
  "icon": "<ICON>",
  "sound": "<SOUND>",
  "color": "<COLOR>",
  "tag": "<TAG>",
  "badge": 0,
  "draft": false,
  "scheduledAt": 
}

Create SMS

Create a new SMS message.

  • Request
    • messageId string
      required

      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.

    • content string
      required

      SMS Content.

    • topics array

      List of Topic IDs.

    • users array

      List of User IDs.

    • targets array

      List of Targets IDs.

    • draft boolean

      Is message a draft

    • scheduledAt string

      Scheduled delivery time for message in ISO 8601 format. DateTime value must be in future.

  • Response
Endpoint
POST /messaging/messages/sms
REST
POST /v1/messaging/messages/sms HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "messageId": "<MESSAGE_ID>",
  "content": "<CONTENT>",
  "topics": [],
  "users": [],
  "targets": [],
  "draft": false,
  "scheduledAt": 
}

Update SMS

Update an email message by its unique ID.

  • Request
    • messageId string
      required

      Message ID.

    • topics array

      List of Topic IDs.

    • users array

      List of User IDs.

    • targets array

      List of Targets IDs.

    • content string

      Email Content.

    • draft boolean

      Is message a draft

    • scheduledAt string

      Scheduled delivery time for message in ISO 8601 format. DateTime value must be in future.

  • Response
Endpoint
PATCH /messaging/messages/sms/{messageId}
REST
PATCH /v1/messaging/messages/sms/{messageId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "topics": [],
  "users": [],
  "targets": [],
  "content": "<CONTENT>",
  "draft": false,
  "scheduledAt": 
}

Get message

Get a message by its unique ID.

  • Request
    • messageId string
      required

      Message ID.

  • Response
Endpoint
GET /messaging/messages/{messageId}
REST
GET /v1/messaging/messages/{messageId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

Delete message

Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.

  • Request
    • messageId string
      required

      Message ID.

  • Response
    • 204 application/json
Endpoint
DELETE /messaging/messages/{messageId}
REST
DELETE /v1/messaging/messages/{messageId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

List message logs

Get the message activity logs listed by its unique ID.

  • Request
    • messageId string
      required

      Message ID.

    • queries array

      Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Only supported methods are limit and offset

  • Response
Endpoint
GET /messaging/messages/{messageId}/logs
REST
GET /v1/messaging/messages/{messageId}/logs HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

List message targets

Get a list of the targets associated with a message.

  • Request
    • messageId string
      required

      Message ID.

    • queries array

      Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, providerId, identifier, providerType

  • Response
Endpoint
GET /messaging/messages/{messageId}/targets
REST
GET /v1/messaging/messages/{messageId}/targets HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

List providers

Get a list of all providers from the current Appwrite project.

  • Request
    • queries array

      Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, provider, type, enabled

    • search string

      Search term to filter your list results. Max length: 256 chars.

  • Response
Endpoint
GET /messaging/providers
REST
GET /v1/messaging/providers HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

Create APNS provider

Create a new Apple Push Notification service provider.

  • Request
    • providerId string
      required

      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.

    • name string
      required

      Provider name.

    • authKey string

      APNS authentication key.

    • authKeyId string

      APNS authentication key ID.

    • teamId string

      APNS team ID.

    • bundleId string

      APNS bundle ID.

    • sandbox boolean

      Use APNS sandbox environment.

    • enabled boolean

      Set as enabled.

  • Response
Endpoint
POST /messaging/providers/apns
REST
POST /v1/messaging/providers/apns HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "providerId": "<PROVIDER_ID>",
  "name": "<NAME>",
  "authKey": "<AUTH_KEY>",
  "authKeyId": "<AUTH_KEY_ID>",
  "teamId": "<TEAM_ID>",
  "bundleId": "<BUNDLE_ID>",
  "sandbox": false,
  "enabled": false
}

Update APNS provider

Update a Apple Push Notification service provider by its unique ID.

  • Request
    • providerId string
      required

      Provider ID.

    • name string

      Provider name.

    • enabled boolean

      Set as enabled.

    • authKey string

      APNS authentication key.

    • authKeyId string

      APNS authentication key ID.

    • teamId string

      APNS team ID.

    • bundleId string

      APNS bundle ID.

    • sandbox boolean

      Use APNS sandbox environment.

  • Response
Endpoint
PATCH /messaging/providers/apns/{providerId}
REST
PATCH /v1/messaging/providers/apns/{providerId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "name": "<NAME>",
  "enabled": false,
  "authKey": "<AUTH_KEY>",
  "authKeyId": "<AUTH_KEY_ID>",
  "teamId": "<TEAM_ID>",
  "bundleId": "<BUNDLE_ID>",
  "sandbox": false
}

Create FCM provider

Create a new Firebase Cloud Messaging provider.

  • Request
    • providerId string
      required

      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.

    • name string
      required

      Provider name.

    • serviceAccountJSON object

      FCM service account JSON.

    • enabled boolean

      Set as enabled.

  • Response
Endpoint
POST /messaging/providers/fcm
REST
POST /v1/messaging/providers/fcm HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "providerId": "<PROVIDER_ID>",
  "name": "<NAME>",
  "serviceAccountJSON": {},
  "enabled": false
}

Update FCM provider

Update a Firebase Cloud Messaging provider by its unique ID.

  • Request
    • providerId string
      required

      Provider ID.

    • name string

      Provider name.

    • enabled boolean

      Set as enabled.

    • serviceAccountJSON object

      FCM service account JSON.

  • Response
Endpoint
PATCH /messaging/providers/fcm/{providerId}
REST
PATCH /v1/messaging/providers/fcm/{providerId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "name": "<NAME>",
  "enabled": false,
  "serviceAccountJSON": {}
}

Create Mailgun provider

Create a new Mailgun provider.

  • Request
    • providerId string
      required

      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.

    • name string
      required

      Provider name.

    • apiKey string

      Mailgun API Key.

    • domain string

      Mailgun Domain.

    • isEuRegion boolean

      Set as EU region.

    • fromName string

      Sender Name.

    • fromEmail string

      Sender email address.

    • replyToName string

      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 string

      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.

    • enabled boolean

      Set as enabled.

  • Response
Endpoint
POST /messaging/providers/mailgun
REST
POST /v1/messaging/providers/mailgun HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "providerId": "<PROVIDER_ID>",
  "name": "<NAME>",
  "apiKey": "<API_KEY>",
  "domain": "<DOMAIN>",
  "isEuRegion": false,
  "fromName": "<FROM_NAME>",
  "fromEmail": "email@example.com",
  "replyToName": "<REPLY_TO_NAME>",
  "replyToEmail": "email@example.com",
  "enabled": false
}

Update Mailgun provider

Update a Mailgun provider by its unique ID.

  • Request
    • providerId string
      required

      Provider ID.

    • name string

      Provider name.

    • apiKey string

      Mailgun API Key.

    • domain string

      Mailgun Domain.

    • isEuRegion boolean

      Set as EU region.

    • enabled boolean

      Set as enabled.

    • fromName string

      Sender Name.

    • fromEmail string

      Sender email address.

    • replyToName string

      Name set in the reply to field for the mail. Default value is sender name.

    • replyToEmail string

      Email set in the reply to field for the mail. Default value is sender email.

  • Response
Endpoint
PATCH /messaging/providers/mailgun/{providerId}
REST
PATCH /v1/messaging/providers/mailgun/{providerId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "name": "<NAME>",
  "apiKey": "<API_KEY>",
  "domain": "<DOMAIN>",
  "isEuRegion": false,
  "enabled": false,
  "fromName": "<FROM_NAME>",
  "fromEmail": "email@example.com",
  "replyToName": "<REPLY_TO_NAME>",
  "replyToEmail": "<REPLY_TO_EMAIL>"
}

Create Msg91 provider

Create a new MSG91 provider.

  • Request
    • providerId string
      required

      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.

    • name string
      required

      Provider name.

    • templateId string

      Msg91 template ID

    • senderId string

      Msg91 sender ID.

    • authKey string

      Msg91 auth key.

    • enabled boolean

      Set as enabled.

  • Response
Endpoint
POST /messaging/providers/msg91
REST
POST /v1/messaging/providers/msg91 HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "providerId": "<PROVIDER_ID>",
  "name": "<NAME>",
  "templateId": "<TEMPLATE_ID>",
  "senderId": "<SENDER_ID>",
  "authKey": "<AUTH_KEY>",
  "enabled": false
}

Update Msg91 provider

Update a MSG91 provider by its unique ID.

  • Request
    • providerId string
      required

      Provider ID.

    • name string

      Provider name.

    • enabled boolean

      Set as enabled.

    • templateId string

      Msg91 template ID.

    • senderId string

      Msg91 sender ID.

    • authKey string

      Msg91 auth key.

  • Response
Endpoint
PATCH /messaging/providers/msg91/{providerId}
REST
PATCH /v1/messaging/providers/msg91/{providerId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "name": "<NAME>",
  "enabled": false,
  "templateId": "<TEMPLATE_ID>",
  "senderId": "<SENDER_ID>",
  "authKey": "<AUTH_KEY>"
}

Create Sendgrid provider

Create a new Sendgrid provider.

  • Request
    • providerId string
      required

      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.

    • name string
      required

      Provider name.

    • apiKey string

      Sendgrid API key.

    • fromName string

      Sender Name.

    • fromEmail string

      Sender email address.

    • replyToName string

      Name set in the reply to field for the mail. Default value is sender name.

    • replyToEmail string

      Email set in the reply to field for the mail. Default value is sender email.

    • enabled boolean

      Set as enabled.

  • Response
Endpoint
POST /messaging/providers/sendgrid
REST
POST /v1/messaging/providers/sendgrid HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "providerId": "<PROVIDER_ID>",
  "name": "<NAME>",
  "apiKey": "<API_KEY>",
  "fromName": "<FROM_NAME>",
  "fromEmail": "email@example.com",
  "replyToName": "<REPLY_TO_NAME>",
  "replyToEmail": "email@example.com",
  "enabled": false
}

Update Sendgrid provider

Update a Sendgrid provider by its unique ID.

  • Request
    • providerId string
      required

      Provider ID.

    • name string

      Provider name.

    • enabled boolean

      Set as enabled.

    • apiKey string

      Sendgrid API key.

    • fromName string

      Sender Name.

    • fromEmail string

      Sender email address.

    • replyToName string

      Name set in the Reply To field for the mail. Default value is Sender Name.

    • replyToEmail string

      Email set in the Reply To field for the mail. Default value is Sender Email.

  • Response
Endpoint
PATCH /messaging/providers/sendgrid/{providerId}
REST
PATCH /v1/messaging/providers/sendgrid/{providerId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "name": "<NAME>",
  "enabled": false,
  "apiKey": "<API_KEY>",
  "fromName": "<FROM_NAME>",
  "fromEmail": "email@example.com",
  "replyToName": "<REPLY_TO_NAME>",
  "replyToEmail": "<REPLY_TO_EMAIL>"
}

Create SMTP provider

Create a new SMTP provider.

  • Request
    • providerId string
      required

      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.

    • name string
      required

      Provider name.

    • host string
      required

      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.

    • port integer

      The default SMTP server port.

    • username string

      Authentication username.

    • password string

      Authentication password.

    • encryption string

      Encryption type. Can be omitted, 'ssl', or 'tls'

    • autoTLS boolean

      Enable SMTP AutoTLS feature.

    • mailer string

      The value to use for the X-Mailer header.

    • fromName string

      Sender Name.

    • fromEmail string

      Sender email address.

    • replyToName string

      Name set in the reply to field for the mail. Default value is sender name.

    • replyToEmail string

      Email set in the reply to field for the mail. Default value is sender email.

    • enabled boolean

      Set as enabled.

  • Response
Endpoint
POST /messaging/providers/smtp
REST
POST /v1/messaging/providers/smtp HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "providerId": "<PROVIDER_ID>",
  "name": "<NAME>",
  "host": "<HOST>",
  "port": 1,
  "username": "<USERNAME>",
  "password": "<PASSWORD>",
  "encryption": "none",
  "autoTLS": false,
  "mailer": "<MAILER>",
  "fromName": "<FROM_NAME>",
  "fromEmail": "email@example.com",
  "replyToName": "<REPLY_TO_NAME>",
  "replyToEmail": "email@example.com",
  "enabled": false
}

Update SMTP provider

Update a SMTP provider by its unique ID.

  • Request
    • providerId string
      required

      Provider ID.

    • name string

      Provider name.

    • host string

      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.

    • port integer

      SMTP port.

    • username string

      Authentication username.

    • password string

      Authentication password.

    • encryption string

      Encryption type. Can be 'ssl' or 'tls'

    • autoTLS boolean

      Enable SMTP AutoTLS feature.

    • mailer string

      The value to use for the X-Mailer header.

    • fromName string

      Sender Name.

    • fromEmail string

      Sender email address.

    • replyToName string

      Name set in the Reply To field for the mail. Default value is Sender Name.

    • replyToEmail string

      Email set in the Reply To field for the mail. Default value is Sender Email.

    • enabled boolean

      Set as enabled.

  • Response
Endpoint
PATCH /messaging/providers/smtp/{providerId}
REST
PATCH /v1/messaging/providers/smtp/{providerId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "name": "<NAME>",
  "host": "<HOST>",
  "port": 1,
  "username": "<USERNAME>",
  "password": "<PASSWORD>",
  "encryption": "none",
  "autoTLS": false,
  "mailer": "<MAILER>",
  "fromName": "<FROM_NAME>",
  "fromEmail": "email@example.com",
  "replyToName": "<REPLY_TO_NAME>",
  "replyToEmail": "<REPLY_TO_EMAIL>",
  "enabled": false
}

Create Telesign provider

Create a new Telesign provider.

  • Request
    • providerId string
      required

      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.

    • name string
      required

      Provider name.

    • from string

      Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.

    • customerId string

      Telesign customer ID.

    • apiKey string

      Telesign API key.

    • enabled boolean

      Set as enabled.

  • Response
Endpoint
POST /messaging/providers/telesign
REST
POST /v1/messaging/providers/telesign HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "providerId": "<PROVIDER_ID>",
  "name": "<NAME>",
  "from": "+12065550100",
  "customerId": "<CUSTOMER_ID>",
  "apiKey": "<API_KEY>",
  "enabled": false
}

Update Telesign provider

Update a Telesign provider by its unique ID.

  • Request
    • providerId string
      required

      Provider ID.

    • name string

      Provider name.

    • enabled boolean

      Set as enabled.

    • customerId string

      Telesign customer ID.

    • apiKey string

      Telesign API key.

    • from string

      Sender number.

  • Response
Endpoint
PATCH /messaging/providers/telesign/{providerId}
REST
PATCH /v1/messaging/providers/telesign/{providerId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "name": "<NAME>",
  "enabled": false,
  "customerId": "<CUSTOMER_ID>",
  "apiKey": "<API_KEY>",
  "from": "<FROM>"
}

Create Textmagic provider

Create a new Textmagic provider.

  • Request
    • providerId string
      required

      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.

    • name string
      required

      Provider name.

    • from string

      Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.

    • username string

      Textmagic username.

    • apiKey string

      Textmagic apiKey.

    • enabled boolean

      Set as enabled.

  • Response
Endpoint
POST /messaging/providers/textmagic
REST
POST /v1/messaging/providers/textmagic HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "providerId": "<PROVIDER_ID>",
  "name": "<NAME>",
  "from": "+12065550100",
  "username": "<USERNAME>",
  "apiKey": "<API_KEY>",
  "enabled": false
}

Update Textmagic provider

Update a Textmagic provider by its unique ID.

  • Request
    • providerId string
      required

      Provider ID.

    • name string

      Provider name.

    • enabled boolean

      Set as enabled.

    • username string

      Textmagic username.

    • apiKey string

      Textmagic apiKey.

    • from string

      Sender number.

  • Response
Endpoint
PATCH /messaging/providers/textmagic/{providerId}
REST
PATCH /v1/messaging/providers/textmagic/{providerId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "name": "<NAME>",
  "enabled": false,
  "username": "<USERNAME>",
  "apiKey": "<API_KEY>",
  "from": "<FROM>"
}

Create Twilio provider

Create a new Twilio provider.

  • Request
    • providerId string
      required

      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.

    • name string
      required

      Provider name.

    • from string

      Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.

    • accountSid string

      Twilio account secret ID.

    • authToken string

      Twilio authentication token.

    • enabled boolean

      Set as enabled.

  • Response
Endpoint
POST /messaging/providers/twilio
REST
POST /v1/messaging/providers/twilio HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "providerId": "<PROVIDER_ID>",
  "name": "<NAME>",
  "from": "+12065550100",
  "accountSid": "<ACCOUNT_SID>",
  "authToken": "<AUTH_TOKEN>",
  "enabled": false
}

Update Twilio provider

Update a Twilio provider by its unique ID.

  • Request
    • providerId string
      required

      Provider ID.

    • name string

      Provider name.

    • enabled boolean

      Set as enabled.

    • accountSid string

      Twilio account secret ID.

    • authToken string

      Twilio authentication token.

    • from string

      Sender number.

  • Response
Endpoint
PATCH /messaging/providers/twilio/{providerId}
REST
PATCH /v1/messaging/providers/twilio/{providerId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "name": "<NAME>",
  "enabled": false,
  "accountSid": "<ACCOUNT_SID>",
  "authToken": "<AUTH_TOKEN>",
  "from": "<FROM>"
}

Create Vonage provider

Create a new Vonage provider.

  • Request
    • providerId string
      required

      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.

    • name string
      required

      Provider name.

    • from string

      Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.

    • apiKey string

      Vonage API key.

    • apiSecret string

      Vonage API secret.

    • enabled boolean

      Set as enabled.

  • Response
Endpoint
POST /messaging/providers/vonage
REST
POST /v1/messaging/providers/vonage HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "providerId": "<PROVIDER_ID>",
  "name": "<NAME>",
  "from": "+12065550100",
  "apiKey": "<API_KEY>",
  "apiSecret": "<API_SECRET>",
  "enabled": false
}

Update Vonage provider

Update a Vonage provider by its unique ID.

  • Request
    • providerId string
      required

      Provider ID.

    • name string

      Provider name.

    • enabled boolean

      Set as enabled.

    • apiKey string

      Vonage API key.

    • apiSecret string

      Vonage API secret.

    • from string

      Sender number.

  • Response
Endpoint
PATCH /messaging/providers/vonage/{providerId}
REST
PATCH /v1/messaging/providers/vonage/{providerId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "name": "<NAME>",
  "enabled": false,
  "apiKey": "<API_KEY>",
  "apiSecret": "<API_SECRET>",
  "from": "<FROM>"
}

Get provider

Get a provider by its unique ID.

  • Request
    • providerId string
      required

      Provider ID.

  • Response
Endpoint
GET /messaging/providers/{providerId}
REST
GET /v1/messaging/providers/{providerId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

Delete provider

Delete a provider by its unique ID.

  • Request
    • providerId string
      required

      Provider ID.

  • Response
    • 204 application/json
Endpoint
DELETE /messaging/providers/{providerId}
REST
DELETE /v1/messaging/providers/{providerId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

List provider logs

Get the provider activity logs listed by its unique ID.

  • Request
    • providerId string
      required

      Provider ID.

    • queries array

      Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Only supported methods are limit and offset

  • Response
Endpoint
GET /messaging/providers/{providerId}/logs
REST
GET /v1/messaging/providers/{providerId}/logs HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

List subscriber logs

Get the subscriber activity logs listed by its unique ID.

  • Request
    • subscriberId string
      required

      Subscriber ID.

    • queries array

      Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Only supported methods are limit and offset

  • Response
Endpoint
GET /messaging/subscribers/{subscriberId}/logs
REST
GET /v1/messaging/subscribers/{subscriberId}/logs HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

List topics

Get a list of all topics from the current Appwrite project.

  • Request
    • queries array

      Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, description, emailTotal, smsTotal, pushTotal

    • search string

      Search term to filter your list results. Max length: 256 chars.

  • Response
Endpoint
GET /messaging/topics
REST
GET /v1/messaging/topics HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

Create topic

Create a new topic.

  • Request
    • topicId string
      required

      Topic ID. Choose a custom Topic ID or a new Topic ID.

    • name string
      required

      Topic Name.

    • subscribe array

      An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. learn more about roles. Maximum of 100 roles are allowed, each 64 characters long.

  • Response
    • 201 application/json
Endpoint
POST /messaging/topics
REST
POST /v1/messaging/topics HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "topicId": "<TOPIC_ID>",
  "name": "<NAME>",
  "subscribe": ["any"]
}

Get topic

Get a topic by its unique ID.

  • Request
    • topicId string
      required

      Topic ID.

  • Response
    • 200 application/json
Endpoint
GET /messaging/topics/{topicId}
REST
GET /v1/messaging/topics/{topicId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

Update topic

Update a topic by its unique ID.

  • Request
    • topicId string
      required

      Topic ID.

    • name string

      Topic Name.

    • subscribe array

      An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. learn more about roles. Maximum of 100 roles are allowed, each 64 characters long.

  • Response
    • 200 application/json
Endpoint
PATCH /messaging/topics/{topicId}
REST
PATCH /v1/messaging/topics/{topicId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

{
  "name": "<NAME>",
  "subscribe": ["any"]
}

Delete topic

Delete a topic by its unique ID.

  • Request
    • topicId string
      required

      Topic ID.

  • Response
    • 204 application/json
Endpoint
DELETE /messaging/topics/{topicId}
REST
DELETE /v1/messaging/topics/{topicId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

List topic logs

Get the topic activity logs listed by its unique ID.

  • Request
    • topicId string
      required

      Topic ID.

    • queries array

      Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Only supported methods are limit and offset

  • Response
Endpoint
GET /messaging/topics/{topicId}/logs
REST
GET /v1/messaging/topics/{topicId}/logs HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

List subscribers

Get a list of all subscribers from the current Appwrite project.

  • Request
    • topicId string
      required

      Topic ID. The topic ID subscribed to.

    • queries array

      Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, provider, type, enabled

    • search string

      Search term to filter your list results. Max length: 256 chars.

  • Response
Endpoint
GET /messaging/topics/{topicId}/subscribers
REST
GET /v1/messaging/topics/{topicId}/subscribers HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

Create subscriber

Create a new subscriber.

  • Request
    • topicId string
      required

      Topic ID. The topic ID to subscribe to.

    • subscriberId string
      required

      Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.

    • targetId string
      required

      Target ID. The target ID to link to the specified Topic ID.

  • Response
Endpoint
POST /messaging/topics/{topicId}/subscribers
REST
POST /v1/messaging/topics/{topicId}/subscribers HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-JWT: <YOUR_JWT>
X-Appwrite-Session: 
X-Appwrite-Key: <YOUR_API_KEY>

{
  "subscriberId": "<SUBSCRIBER_ID>",
  "targetId": "<TARGET_ID>"
}

Get subscriber

Get a subscriber by its unique ID.

  • Request
    • topicId string
      required

      Topic ID. The topic ID subscribed to.

    • subscriberId string
      required

      Subscriber ID.

  • Response
Endpoint
GET /messaging/topics/{topicId}/subscribers/{subscriberId}
REST
GET /v1/messaging/topics/{topicId}/subscribers/{subscriberId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-Key: <YOUR_API_KEY>

Delete subscriber

Delete a subscriber by its unique ID.

  • Request
    • topicId string
      required

      Topic ID. The topic ID subscribed to.

    • subscriberId string
      required

      Subscriber ID.

  • Response
    • 204 application/json
Endpoint
DELETE /messaging/topics/{topicId}/subscribers/{subscriberId}
REST
DELETE /v1/messaging/topics/{topicId}/subscribers/{subscriberId} HTTP/1.1
Host: cloud.appwrite.io
Content-Type: application/json
X-Appwrite-Response-Format: 1.6.0
X-Appwrite-Project: <YOUR_PROJECT_ID>
X-Appwrite-JWT: <YOUR_JWT>
X-Appwrite-Session: 
X-Appwrite-Key: <YOUR_API_KEY>
Copyright © 2024 Appwrite