• Document Up to Date
  • Updated On 4.0.0

Subscribe

Subscribes the current user to a given thread.

Resource Information

This service uses the tomcat application on port 8080 by default.

The context for this API is /crafter-social, please prefix the API URLs with this context.

HTTP Verb
POST, PUT
URL
/api/3/threads/:id/subscribe
Response Formats
JSON

Parameters

Name
Type
Required
Description
context
String
The ID of the Social Context
id
String
The ID of the thread to subscribe
frequency
String

Type of notifications to receive

Note

The possible values for the frequency parameter are:

  • weekly

  • daily

  • instant

Example

Request

POST .../api/3/threads/Welcome/subscribe
context=f5b143c2-f1c0-4a10-b56e-f485f00d3fe9
frequency=weekly

Response

Status 200 OK

1true

Responses

Status
Location
Response Body
200

See example above.
401

{ "message" : "User must be logged in" }
403







{ "message" : "Current subject does not have
permission to execute global action ..." }
500

{ "message" : "Internal server error" }