Docs
Skip to content
post

Create APNS provider

Endpoint

posthttps://<REGION>.cloud.appwrite.io/v1/messaging/providers/apns

Description

Create a new Apple Push Notification service provider.

Required scopes

providers.write

Authentication

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

Parameters

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.

string
Required

Provider name.

string

APNS authentication key.

string

APNS authentication key ID.

string

APNS team ID.

string

APNS bundle ID.

boolean

Use APNS sandbox environment.

boolean

Set as enabled.

Status
Content type
201
application/json

Provider

Name
Type
Description
string

Provider ID.

string

Provider creation time in ISO 8601 format.

string

Provider update date in ISO 8601 format.

string

The name for the provider instance.

string

The name of the provider service.

boolean

Is provider enabled?

string

Type of provider.

object

Provider credentials.

object

Provider options.

Kotlin
import io.appwrite.Client
import io.appwrite.coroutines.CoroutineCallback
import io.appwrite.services.Messaging


val client = Client()
    .setEndpoint("https://<REGION>.cloud.appwrite.io/v1") // Your API Endpoint
    .setProject("<YOUR_PROJECT_ID>") // Your project ID
    .setKey("<YOUR_API_KEY>") // Your secret API key


val messaging = Messaging(client)


val response = messaging.createApnsProvider(
    providerId = "<PROVIDER_ID>",
    name = "<NAME>",
    authKey = "<AUTH_KEY>", // optional
    authKeyId = "<AUTH_KEY_ID>", // optional
    teamId = "<TEAM_ID>", // optional
    bundleId = "<BUNDLE_ID>", // optional
    sandbox = false, // optional
    enabled = false // optional
)