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.
https://cloud.appwrite.io/v1
List messages
Get a list of all messages from the current Appwrite project.
Request
queries 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 Search term to filter your list results. Max length: 256 chars.
Response
200
GET /messaging/messages
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 requiredMessage 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 requiredEmail Subject.
content requiredEmail Content.
topics List of Topic IDs.
users List of User IDs.
targets List of Targets IDs.
cc Array of target IDs to be added as CC.
bcc Array of target IDs to be added as BCC.
attachments 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 Is message a draft
html Is content of type HTML
scheduledAt Scheduled delivery time for message in ISO 8601 format. DateTime value must be in future.
Response
201
POST /messaging/messages/email
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 requiredMessage ID.
topics List of Topic IDs.
users List of User IDs.
targets List of Targets IDs.
subject Email Subject.
content Email Content.
draft Is message a draft
html Is content of type HTML
cc Array of target IDs to be added as CC.
bcc Array of target IDs to be added as BCC.
scheduledAt Scheduled delivery time for message in ISO 8601 format. DateTime value must be in future.
attachments 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
200
PATCH /messaging/messages/email/{messageId}
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 requiredMessage 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 requiredTitle for push notification.
body requiredBody for push notification.
topics List of Topic IDs.
users List of User IDs.
targets List of Targets IDs.
data Additional Data for push notification.
action Action for push notification.
image 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 Icon for push notification. Available only for Android and Web Platform.
sound Sound for push notification. Available only for Android and IOS Platform.
color Color for push notification. Available only for Android Platform.
tag Tag for push notification. Available only for Android Platform.
badge Badge for push notification. Available only for IOS Platform.
draft Is message a draft
scheduledAt Scheduled delivery time for message in ISO 8601 format. DateTime value must be in future.
Response
201
POST /messaging/messages/push
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 requiredMessage ID.
topics List of Topic IDs.
users List of User IDs.
targets List of Targets IDs.
title Title for push notification.
body Body for push notification.
data Additional Data for push notification.
action Action for push notification.
image 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 Icon for push notification. Available only for Android and Web platforms.
sound Sound for push notification. Available only for Android and iOS platforms.
color Color for push notification. Available only for Android platforms.
tag Tag for push notification. Available only for Android platforms.
badge Badge for push notification. Available only for iOS platforms.
draft Is message a draft
scheduledAt Scheduled delivery time for message in ISO 8601 format. DateTime value must be in future.
Response
200
PATCH /messaging/messages/push/{messageId}
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 requiredMessage 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 requiredSMS Content.
topics List of Topic IDs.
users List of User IDs.
targets List of Targets IDs.
draft Is message a draft
scheduledAt Scheduled delivery time for message in ISO 8601 format. DateTime value must be in future.
Response
201
POST /messaging/messages/sms
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.
PATCH /messaging/messages/sms/{messageId}
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 /messaging/messages/{messageId}
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 requiredMessage ID.
Response
204
DELETE /messaging/messages/{messageId}
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 requiredMessage ID.
queries 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
200
GET /messaging/messages/{messageId}/logs
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 requiredMessage ID.
queries 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
200
GET /messaging/messages/{messageId}/targets
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 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 Search term to filter your list results. Max length: 256 chars.
Response
200
GET /messaging/providers
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 requiredProvider 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 requiredProvider name.
authKey APNS authentication key.
authKeyId APNS authentication key ID.
teamId APNS team ID.
bundleId APNS bundle ID.
sandbox Use APNS sandbox environment.
enabled Set as enabled.
Response
201
POST /messaging/providers/apns
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 requiredProvider ID.
name Provider name.
enabled Set as enabled.
authKey APNS authentication key.
authKeyId APNS authentication key ID.
teamId APNS team ID.
bundleId APNS bundle ID.
sandbox Use APNS sandbox environment.
Response
200
PATCH /messaging/providers/apns/{providerId}
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 requiredProvider 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 requiredProvider name.
serviceAccountJSON FCM service account JSON.
enabled Set as enabled.
Response
201
POST /messaging/providers/fcm
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 requiredProvider ID.
name Provider name.
enabled Set as enabled.
serviceAccountJSON FCM service account JSON.
Response
200
PATCH /messaging/providers/fcm/{providerId}
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 requiredProvider 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 requiredProvider name.
apiKey Mailgun API Key.
domain Mailgun Domain.
isEuRegion Set as EU region.
fromName Sender Name.
fromEmail Sender email address.
replyToName 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 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 Set as enabled.
Response
201
POST /messaging/providers/mailgun
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 protected]",
"replyToName": "<REPLY_TO_NAME>",
"replyToEmail": "[email protected]",
"enabled": false
}
Update Mailgun provider
Update a Mailgun provider by its unique ID.
Request
providerId requiredProvider ID.
name Provider name.
apiKey Mailgun API Key.
domain Mailgun Domain.
isEuRegion Set as EU region.
enabled Set as enabled.
fromName Sender Name.
fromEmail Sender email address.
replyToName Name set in the reply to field for the mail. Default value is sender name.
replyToEmail Email set in the reply to field for the mail. Default value is sender email.
Response
200
PATCH /messaging/providers/mailgun/{providerId}
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 protected]",
"replyToName": "<REPLY_TO_NAME>",
"replyToEmail": "<REPLY_TO_EMAIL>"
}
Create Msg91 provider
Create a new MSG91 provider.
Request
providerId requiredProvider 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 requiredProvider name.
templateId Msg91 template ID
senderId Msg91 sender ID.
authKey Msg91 auth key.
enabled Set as enabled.
Response
201
POST /messaging/providers/msg91
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 requiredProvider ID.
name Provider name.
enabled Set as enabled.
templateId Msg91 template ID.
senderId Msg91 sender ID.
authKey Msg91 auth key.
Response
200
PATCH /messaging/providers/msg91/{providerId}
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 requiredProvider 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 requiredProvider name.
apiKey Sendgrid API key.
fromName Sender Name.
fromEmail Sender email address.
replyToName Name set in the reply to field for the mail. Default value is sender name.
replyToEmail Email set in the reply to field for the mail. Default value is sender email.
enabled Set as enabled.
Response
201
POST /messaging/providers/sendgrid
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 protected]",
"replyToName": "<REPLY_TO_NAME>",
"replyToEmail": "[email protected]",
"enabled": false
}
Update Sendgrid provider
Update a Sendgrid provider by its unique ID.
Request
providerId requiredProvider ID.
name Provider name.
enabled Set as enabled.
apiKey Sendgrid API key.
fromName Sender Name.
fromEmail Sender email address.
replyToName Name set in the Reply To field for the mail. Default value is Sender Name.
replyToEmail Email set in the Reply To field for the mail. Default value is Sender Email.
Response
200
PATCH /messaging/providers/sendgrid/{providerId}
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 protected]",
"replyToName": "<REPLY_TO_NAME>",
"replyToEmail": "<REPLY_TO_EMAIL>"
}
Create SMTP provider
Create a new SMTP provider.
Request
providerId requiredProvider 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 requiredProvider name.
host requiredSMTP 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 The default SMTP server port.
username Authentication username.
password Authentication password.
encryption Encryption type. Can be omitted, 'ssl', or 'tls'
autoTLS Enable SMTP AutoTLS feature.
mailer The value to use for the X-Mailer header.
fromName Sender Name.
fromEmail Sender email address.
replyToName Name set in the reply to field for the mail. Default value is sender name.
replyToEmail Email set in the reply to field for the mail. Default value is sender email.
enabled Set as enabled.
Response
201
POST /messaging/providers/smtp
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 protected]",
"replyToName": "<REPLY_TO_NAME>",
"replyToEmail": "[email protected]",
"enabled": false
}
Update SMTP provider
Update a SMTP provider by its unique ID.
Request
providerId requiredProvider ID.
name Provider name.
host 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 SMTP port.
username Authentication username.
password Authentication password.
encryption Encryption type. Can be 'ssl' or 'tls'
autoTLS Enable SMTP AutoTLS feature.
mailer The value to use for the X-Mailer header.
fromName Sender Name.
fromEmail Sender email address.
replyToName Name set in the Reply To field for the mail. Default value is Sender Name.
replyToEmail Email set in the Reply To field for the mail. Default value is Sender Email.
enabled Set as enabled.
Response
200
PATCH /messaging/providers/smtp/{providerId}
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 protected]",
"replyToName": "<REPLY_TO_NAME>",
"replyToEmail": "<REPLY_TO_EMAIL>",
"enabled": false
}
Create Telesign provider
Create a new Telesign provider.
Request
providerId requiredProvider 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 requiredProvider name.
from Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
customerId Telesign customer ID.
apiKey Telesign API key.
enabled Set as enabled.
Response
201
POST /messaging/providers/telesign
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 requiredProvider ID.
name Provider name.
enabled Set as enabled.
customerId Telesign customer ID.
apiKey Telesign API key.
from Sender number.
Response
200
PATCH /messaging/providers/telesign/{providerId}
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 requiredProvider 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 requiredProvider name.
from Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
username Textmagic username.
apiKey Textmagic apiKey.
enabled Set as enabled.
Response
201
POST /messaging/providers/textmagic
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 requiredProvider ID.
name Provider name.
enabled Set as enabled.
username Textmagic username.
apiKey Textmagic apiKey.
from Sender number.
Response
200
PATCH /messaging/providers/textmagic/{providerId}
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 requiredProvider 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 requiredProvider name.
from Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
accountSid Twilio account secret ID.
authToken Twilio authentication token.
enabled Set as enabled.
Response
201
POST /messaging/providers/twilio
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 requiredProvider ID.
name Provider name.
enabled Set as enabled.
accountSid Twilio account secret ID.
authToken Twilio authentication token.
from Sender number.
Response
200
PATCH /messaging/providers/twilio/{providerId}
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 requiredProvider 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 requiredProvider name.
from Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
apiKey Vonage API key.
apiSecret Vonage API secret.
enabled Set as enabled.
Response
201
POST /messaging/providers/vonage
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 requiredProvider ID.
name Provider name.
enabled Set as enabled.
apiKey Vonage API key.
apiSecret Vonage API secret.
from Sender number.
Response
200
PATCH /messaging/providers/vonage/{providerId}
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 /messaging/providers/{providerId}
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 requiredProvider ID.
Response
204
DELETE /messaging/providers/{providerId}
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 requiredProvider ID.
queries 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
200
GET /messaging/providers/{providerId}/logs
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 requiredSubscriber ID.
queries 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
200
GET /messaging/subscribers/{subscriberId}/logs
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 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 Search term to filter your list results. Max length: 256 chars.
Response
200
GET /messaging/topics
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 requiredTopic ID. Choose a custom Topic ID or a new Topic ID.
name requiredTopic Name.
subscribe 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
POST /messaging/topics
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 /messaging/topics/{topicId}
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 requiredTopic ID.
name Topic Name.
subscribe 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
PATCH /messaging/topics/{topicId}
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 /messaging/topics/{topicId}
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 requiredTopic ID.
queries 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
200
GET /messaging/topics/{topicId}/logs
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 requiredTopic ID. The topic ID subscribed to.
queries 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 Search term to filter your list results. Max length: 256 chars.
Response
200
GET /messaging/topics/{topicId}/subscribers
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 requiredTopic ID. The topic ID to subscribe to.
subscriberId requiredSubscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.
targetId requiredTarget ID. The target ID to link to the specified Topic ID.
Response
201
POST /messaging/topics/{topicId}/subscribers
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 requiredTopic ID. The topic ID subscribed to.
subscriberId requiredSubscriber ID.
Response
200
GET /messaging/topics/{topicId}/subscribers/{subscriberId}
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 requiredTopic ID. The topic ID subscribed to.
subscriberId requiredSubscriber ID.
Response
204
DELETE /messaging/topics/{topicId}/subscribers/{subscriberId}
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>