Pin a community

POST

/categories/{category}/pin

const url = 'https://feed.work.optidata.cloud/api/categories/864/pin';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://feed.work.optidata.cloud/api/categories/864/pin \
  --header 'Authorization: Bearer <token>'

Pins the community for the caller, so it sticks to the top of their community list.

Authorizations

bearerAuth

Parameters

Path Parameters

category

required

integer

Numeric id of the community.

Responses

200

Pin changes applied.

application/json

Which pins changed.

object

attached

required

Array<integer>

detached

required

Array<integer>

updated

required

Array<integer>

Examples

example

{
  "attached": [
    864
  ],
  "detached": [],
  "updated": []
}

401

No authentication key was sent.

application/json

Authentication failures use an error key.

object

error

required

string

Examples

example

{
  "error": "JWT passport exception: Missing bearer token in request"
}

404

No matching resource, or it is not reachable through this path.

application/json

object

message

required

string

Examples

example

{
  "message": "No query results for model [App\\Models\\Category] 864"
}

419

The authentication key is expired or not recognised. Get a fresh one and retry.

application/json

Authentication failures use an error key.

object

error

required

string

Examples

example

{
  "error": "JWT passport expired: Passport expired"
}