Get user subscription topic
Fetch user preferences for a specific subscription topic.
URL: https://api.courier.com/users/:user_id/preferences/:topic_id
Method: GET
Path Parameters
user_idstringrequired
A unique identifier associated with the user whose preferences you wish to retrieve.
topic_idstringrequired
A unique identifier associated with a subscription topic.
Responses
status: 200 OK
topicobject
The Preferences associated with the user_id for a particular subscription topic.
+ Show Properties
status: 404 Not Found
messagestring
A message describing the error that occurred.
typestring
[invalid_request_error] The type of error that occurred.
Request Example
- cURL
- Node.js
- Ruby
- Python
- Go
- PHP
curl --request GET \
--url https://api.courier.com/users/example_user_id/preferences/FW0YU64P4TMYKMMHH67D6FENX8VS \
--header 'Accept: application/json'
// Dependencies to install:
// $ npm install node-fetch --save
const fetch = require('node-fetch');
const options = {
method: 'GET',
headers: {
Accept: 'application/json'
},
};
fetch('https://api.courier.com/users/example_user_id/preferences/FW0YU64P4TMYKMMHH67D6FENX8VS', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://api.courier.com/users/example_user_id/preferences/FW0YU64P4TMYKMMHH67D6FENX8VS")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
response = http.request(request)
puts response.read_body
# Dependencies to install:
# $ python -m pip install requests
import requests
url = "https://api.courier.com/users/example_user_id/preferences/FW0YU64P4TMYKMMHH67D6FENX8VS"
headers = {
"Accept": "application/json"
}
response = requests.request("GET", url, headers=headers)
print(response.text)
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.courier.com/users/example_user_id/preferences/FW0YU64P4TMYKMMHH67D6FENX8VS"
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Accept", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
<?php
// Dependencies to install:
// $ composer require guzzlehttp/guzzle
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.courier.com/users/example_user_id/preferences/FW0YU64P4TMYKMMHH67D6FENX8VS', [
'headers' => [
'Accept' => 'application/json',
],
]);
echo $response->getBody();
Responses Example
{
"topic": {
"default_status": "OPT_IN",
"has_custom_routing": true,
"custom_routing": [
"email"
],
"status": "OPTED_OUT",
"section_name": "Essential Notifications",
"section_id": "Essential Notifications",
"topic_id": "FW0YU64P4TMYKMMHH67D6FENX8VS",
"topic_name": "Invitations"
}
}
{
"message": "Not Found",
"type": "invalid_request_error"
}
Example
Method: GET
URL: https://api.courier.com/users/example_user_id/preferences/FW0YU64P4TMYKMMHH67D6FENX8VS