Clear all pin posts in a community by placement

curl --request DELETE \
  --url https://apix.us.amity.co/api/v1/pinned-posts/communities/{communityId}/{placement} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://apix.us.amity.co/api/v1/pinned-posts/communities/{communityId}/{placement}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://apix.us.amity.co/api/v1/pinned-posts/communities/{communityId}/{placement}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apix.us.amity.co/api/v1/pinned-posts/communities/{communityId}/{placement}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.us.amity.co/api/v1/pinned-posts/communities/{communityId}/{placement}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v1/pinned-posts/communities/{communityId}/{placement}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true
}

{
  "status": "error",
  "code": 400300,
  "message": "You are not allowed to do this"
}

{
  "status": "error",
  "code": 400400,
  "message": "CommunityId ${id} not found"
}

{
  "status": "error",
  "code": 500000,
  "message": "Parameters validation error"
}

{
  "status": "error",
  "code": 500000,
  "message": "Unexpected error"
}

DELETE

api

pinned-posts

communities

{communityId}

{placement}

Clear all pin posts in a community by placement

curl --request DELETE \
  --url https://apix.us.amity.co/api/v1/pinned-posts/communities/{communityId}/{placement} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://apix.us.amity.co/api/v1/pinned-posts/communities/{communityId}/{placement}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://apix.us.amity.co/api/v1/pinned-posts/communities/{communityId}/{placement}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apix.us.amity.co/api/v1/pinned-posts/communities/{communityId}/{placement}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.us.amity.co/api/v1/pinned-posts/communities/{communityId}/{placement}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v1/pinned-posts/communities/{communityId}/{placement}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true
}

{
  "status": "error",
  "code": 400300,
  "message": "You are not allowed to do this"
}

{
  "status": "error",
  "code": 400400,
  "message": "CommunityId ${id} not found"
}

{
  "status": "error",
  "code": 500000,
  "message": "Parameters validation error"
}

{
  "status": "error",
  "code": 500000,
  "message": "Unexpected error"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

communityId

string

required

Maximum string length: 900

placement

enum<string>

required

Available options:

default,

announcement

Response

success

boolean

List all pinned posts in a community by placement Pin a post in a community

⌘I