Docs
Skip to content
post

Create subscriber

Endpoint

posthttps://<REGION>.cloud.appwrite.io...saging/topics/{topicId}/subscribers

Description

Create a new subscriber.

Required scopes

subscribers.write

Authentication

Initialize the Appwrite client with setProject() and ensure the user is signed in. The SDK sends the session header automatically after login.

Path

string
Required

Topic ID. The topic ID to subscribe to.

Body

string
Required

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

string
Required

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

Status
Content type
201
application/json

Subscriber

Name
Type
Description
string

Subscriber ID.

string

Subscriber creation time in ISO 8601 format.

string

Subscriber update date in ISO 8601 format.

string

Target ID.

object

Target.

string

Topic ID.

string

User Name.

string

Topic ID.

string

The target provider type. Can be one of the following: email, sms or push.

JavaScript
import { Client, Messaging } from "appwrite";


const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>'); // Your project ID


const messaging = new Messaging(client);


const result = await messaging.createSubscriber({
    topicId: '<TOPIC_ID>',
    subscriberId: '<SUBSCRIBER_ID>',
    targetId: '<TARGET_ID>'
});


console.log(result);