Create a forum opportunity
curl --request POST \
--url https://api.rankspot.ai/v1/forum-opportunities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "How to start a blog in 2024",
"url": "https://reddit.com/r/blogging/comments/abc123",
"competitorId": "clx..."
}
'import requests
url = "https://api.rankspot.ai/v1/forum-opportunities"
payload = {
"title": "How to start a blog in 2024",
"url": "https://reddit.com/r/blogging/comments/abc123",
"competitorId": "clx..."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: 'How to start a blog in 2024',
url: 'https://reddit.com/r/blogging/comments/abc123',
competitorId: 'clx...'
})
};
fetch('https://api.rankspot.ai/v1/forum-opportunities', 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://api.rankspot.ai/v1/forum-opportunities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => 'How to start a blog in 2024',
'url' => 'https://reddit.com/r/blogging/comments/abc123',
'competitorId' => 'clx...'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.rankspot.ai/v1/forum-opportunities"
payload := strings.NewReader("{\n \"title\": \"How to start a blog in 2024\",\n \"url\": \"https://reddit.com/r/blogging/comments/abc123\",\n \"competitorId\": \"clx...\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.rankspot.ai/v1/forum-opportunities")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"How to start a blog in 2024\",\n \"url\": \"https://reddit.com/r/blogging/comments/abc123\",\n \"competitorId\": \"clx...\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rankspot.ai/v1/forum-opportunities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"How to start a blog in 2024\",\n \"url\": \"https://reddit.com/r/blogging/comments/abc123\",\n \"competitorId\": \"clx...\"\n}"
response = http.request(request)
puts response.read_body{
"id": "clx...",
"title": "How to start a blog in 2024",
"url": "https://reddit.com/r/blogging/comments/abc123",
"status": "new",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"competitorId": "clx..."
}Forum Opportunities
Create a forum opportunity
Adds a forum thread or community post as a link-building opportunity. The url must be unique per workspace — if the same URL is submitted again, the existing record is returned unchanged (idempotent). Optionally associate the opportunity with a tracked competitor via competitorId.
POST
https://api.rankspot.ai
/
v1
/
forum-opportunities
Create a forum opportunity
curl --request POST \
--url https://api.rankspot.ai/v1/forum-opportunities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "How to start a blog in 2024",
"url": "https://reddit.com/r/blogging/comments/abc123",
"competitorId": "clx..."
}
'import requests
url = "https://api.rankspot.ai/v1/forum-opportunities"
payload = {
"title": "How to start a blog in 2024",
"url": "https://reddit.com/r/blogging/comments/abc123",
"competitorId": "clx..."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: 'How to start a blog in 2024',
url: 'https://reddit.com/r/blogging/comments/abc123',
competitorId: 'clx...'
})
};
fetch('https://api.rankspot.ai/v1/forum-opportunities', 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://api.rankspot.ai/v1/forum-opportunities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => 'How to start a blog in 2024',
'url' => 'https://reddit.com/r/blogging/comments/abc123',
'competitorId' => 'clx...'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.rankspot.ai/v1/forum-opportunities"
payload := strings.NewReader("{\n \"title\": \"How to start a blog in 2024\",\n \"url\": \"https://reddit.com/r/blogging/comments/abc123\",\n \"competitorId\": \"clx...\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.rankspot.ai/v1/forum-opportunities")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"How to start a blog in 2024\",\n \"url\": \"https://reddit.com/r/blogging/comments/abc123\",\n \"competitorId\": \"clx...\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rankspot.ai/v1/forum-opportunities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"How to start a blog in 2024\",\n \"url\": \"https://reddit.com/r/blogging/comments/abc123\",\n \"competitorId\": \"clx...\"\n}"
response = http.request(request)
puts response.read_body{
"id": "clx...",
"title": "How to start a blog in 2024",
"url": "https://reddit.com/r/blogging/comments/abc123",
"status": "new",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"competitorId": "clx..."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
201 - application/json
Example:
"clx..."
Example:
"How to start a blog in 2024"
Example:
"https://reddit.com/r/blogging/comments/abc123"
Available options:
new, processed Example:
"new"
Example:
"clx..."
⌘I
