# Subscribe or unsubscribe a contact from a topic Source: https://jointextkit.com/docs/api/contacts/set-topic Index: https://jointextkit.com/llms.txt `PUT /v1/contacts/{id}/topics/{topic}` `topic` is a topic id or name. Recorded in the consent ledger and the audit log. No record means subscribed, so only an unsubscribe narrows who is sent to. Subscribing to a topic does not lift an opt-out. Send your API key as a bearer token: `Authorization: Bearer ssms_sk_...`. Test keys run this endpoint against the [sandbox](/docs/sandbox); see [Authentication](/docs/authentication) for key modes and scopes. ## Path parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | `id` | string | Yes | Contact id or phone number | | `topic` | string | Yes | Topic id (tp_...) or name | ## Request body JSON (`Content-Type: application/json`). | Field | Type | Required | Description | | --- | --- | --- | --- | | `subscribed` | boolean | Yes | | | `source` | string | No | Where the change came from, e.g. "preference_page". Default "api". | ## Responses | Status | Meaning | Body | | --- | --- | --- | | 200 | The new state; `changed` is false when it already was | JSON object | | 401 | Missing, malformed, or revoked API key | `Error` | | 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged | `Error` | | 404 | No such contact, number, or topic | `Error` | | 429 | Rate limit or quota exceeded | `Error` | ### 200: response fields | Field | Type | Description | | --- | --- | --- | | `object` | `topic_subscription` | | | `phone` | string | | | `contact_id` | string | Nullable. | | `topic_id` | string | | | `name` | string | | | `subscribed` | boolean | | | `changed` | boolean | | ## Errors | Status | When | | --- | --- | | 401 | Missing, malformed, or revoked API key | | 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged | | 404 | No such contact, number, or topic | | 429 | Rate limit or quota exceeded | Every error has the same JSON shape, and `request_id` matches the `X-Request-Id` response header. [Errors](/docs/errors) lists every code and what to do about it. ```json { "error": { "code": "invalid_request", "message": "What went wrong, in plain words.", "param": "the_field", "request_id": "req_a1B2c3D4e5F6g7H8" } } ``` ## Examples ### Node.js The Node.js SDK does not wrap this endpoint yet; call it over HTTP. ```javascript const res = await fetch('https://api.jointextkit.com/v1/contacts/ct_a1B2c3D4e5F6/topics/tp_marketing', { method: 'PUT', headers: { Authorization: `Bearer ${process.env.TEXTKIT_API_KEY}`, 'Content-Type': 'application/json', }, body: JSON.stringify({ "subscribed": true }), }); if (!res.ok) throw new Error((await res.json()).error.message); const data = await res.json(); ``` ### PHP ```php 'PUT', CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ' . getenv('TEXTKIT_API_KEY'), 'Content-Type: application/json', ], CURLOPT_POSTFIELDS => json_encode([ 'subscribed' => true, ]), ]); $data = json_decode(curl_exec($ch), true); ``` ### Python The Python SDK does not wrap this endpoint yet; call it over HTTP. ```python import json, os, urllib.request req = urllib.request.Request( "https://api.jointextkit.com/v1/contacts/ct_a1B2c3D4e5F6/topics/tp_marketing", method="PUT", headers={ "Authorization": f"Bearer {os.environ['TEXTKIT_API_KEY']}", "Content-Type": "application/json", }, data=json.dumps({ "subscribed": True }).encode(), ) with urllib.request.urlopen(req) as res: data = json.load(res) ``` ### Ruby ```ruby require "net/http" require "json" uri = URI("https://api.jointextkit.com/v1/contacts/ct_a1B2c3D4e5F6/topics/tp_marketing") req = Net::HTTP::Put.new(uri) req["Authorization"] = "Bearer #{ENV["TEXTKIT_API_KEY"]}" req["Content-Type"] = "application/json" req.body = { "subscribed": true }.to_json res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) } data = JSON.parse(res.body) ``` ### Go ```go package main import ( "fmt" "io" "net/http" "os" "strings" ) func main() { body := strings.NewReader(`{ "subscribed": true }`) req, _ := http.NewRequest("PUT", "https://api.jointextkit.com/v1/contacts/ct_a1B2c3D4e5F6/topics/tp_marketing", body) req.Header.Set("Authorization", "Bearer "+os.Getenv("TEXTKIT_API_KEY")) req.Header.Set("Content-Type", "application/json") res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() data, _ := io.ReadAll(res.Body) fmt.Println(res.Status, string(data)) } ``` ### Rust ```rust // cargo add reqwest --features blocking,json // cargo add serde_json use serde_json::json; fn main() -> Result<(), Box> { let key = std::env::var("TEXTKIT_API_KEY")?; let res = reqwest::blocking::Client::new() .put("https://api.jointextkit.com/v1/contacts/ct_a1B2c3D4e5F6/topics/tp_marketing") .bearer_auth(key) .json(&json!({ "subscribed": true })) .send()? .error_for_status()?; let data: serde_json::Value = res.json()?; println!("{data}"); Ok(()) } ``` ### Java ```java import java.net.URI; import java.net.http.*; public class Main { public static void main(String[] args) throws Exception { var request = HttpRequest.newBuilder(URI.create("https://api.jointextkit.com/v1/contacts/ct_a1B2c3D4e5F6/topics/tp_marketing")) .header("Authorization", "Bearer " + System.getenv("TEXTKIT_API_KEY")) .header("Content-Type", "application/json") .method("PUT", HttpRequest.BodyPublishers.ofString(""" { "subscribed": true } """)) .build(); var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.statusCode() + " " + response.body()); } } ``` ### .NET ```csharp using System.Net.Http.Headers; using System.Text; var http = new HttpClient(); http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue( "Bearer", Environment.GetEnvironmentVariable("TEXTKIT_API_KEY")); var body = new StringContent(""" { "subscribed": true } """, Encoding.UTF8, "application/json"); var res = await http.PutAsync("https://api.jointextkit.com/v1/contacts/ct_a1B2c3D4e5F6/topics/tp_marketing", body); res.EnsureSuccessStatusCode(); var data = await res.Content.ReadAsStringAsync(); ``` ### cURL ```bash curl -X PUT "https://api.jointextkit.com/v1/contacts/ct_a1B2c3D4e5F6/topics/tp_marketing" \ -H "Authorization: Bearer $TEXTKIT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "subscribed": true }' ``` ## Related - Guide: [Contacts](/docs/contacts) - [All contacts endpoints](/docs/api#contacts) - [API reference](/docs/api)