Subscribe a device to a channel

POST /push/channelSubscriptions

Subscribe either a single device or all devices associated with a client ID to receive push notifications from messages sent to a channel.

Body object

channel string

Channel name.
deviceId string

Must be set when clientId is empty, cannot be used with clientId.

Responses

2XX

OK
default

Error
Hide headers attributes Show headers attributes
- x-ably-errorcode integer
  
  The error code.
- x-ably-errormessage string
  
  The error message.
- x-ably-serverid string Required
  
  The ID for the server communicated with.
Hide response attributes Show response attributes object
- message string
  
  Message explaining the error's cause.
- code integer
  
  Error code.
- statusCode integer
  
  Status error code.
- href string
  
  Link to help with error.
- serverId string
  
  Server ID with which error was encountered.

POST /push/channelSubscriptions

curl \
 -X POST https://rest.ably.io/push/channelSubscriptions \
 -H "Content-Type: application/json" \
 -d '{"channel":"my:channel","clientId":"myClientId"}'

Request example

{
  "channel": "my:channel",
  "clientId": "myClientId"
}

Request examples

{
  "channel": "string",
  "deviceId": "string"
}

{
  "channel": "string",
  "clientId": "string"
}

Response examples (default)

# Headers
x-ably-errorcode: 42
x-ably-errormessage: string
x-ably-serverid: string

# Payload
{
  "message": "string",
  "code": 42,
  "statusCode": 42,
  "href": "string",
  "serverId": "string"
}

Response examples (default)

# Headers
x-ably-errorcode: 42
x-ably-errormessage: string
x-ably-serverid: string

# Payload
{
  "message": "string",
  "code": 42,
  "statusCode": 42,
  "href": "string",
  "serverId": "string"
}