# Set consent state from your own system (CRM sync)

Source: https://jointextkit.com/docs/api/consent/set
Index: https://jointextkit.com/llms.txt

`POST /v1/consent/{phone}`

Opting in a number that opted out needs `proof` with `collected_at` at or after the opt-out (a STOP cancels earlier consent); otherwise 409 `invalid_request` with `param` `proof` or `proof.collected_at`, and nothing changes.

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 |
| --- | --- | --- | --- |
| `phone` | string | Yes |  |

## Request body

JSON (`Content-Type: application/json`).

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `status` | `opted_out`, `opted_in` | Yes |  |
| `note` | string | No | At most 200 characters. |
| `campaign_id` | string | No | Only with opted_in: the registration the person opted in to. A marketing send from a number linked to that registration looks for this record. Proof is required when its use case is marketing or mixed (400 otherwise). An opt-out is always account-wide. Example: `reg_a1B2c3D4e5F6`. |
| `proof` | OptInProof | No | Opt-in evidence (Messaging Policy 1.4). Accepted only with status opted_in. |

## Responses

| Status | Meaning | Body |
| --- | --- | --- |
| 200 | Updated consent state | `Consent` |
| 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` |
| 409 | The number opted out, and the opt-in carries no proof collected at or after the opt-out | `Error` |
| 429 | Rate limit or quota exceeded | `Error` |

### 200: `Consent` fields

| Field | Type | Description |
| --- | --- | --- |
| `object` | `consent` |  |
| `phone` | string | Example: `+14155550132`. |
| `status` | `opted_out`, `opted_in`, `no_record` |  |
| `updated_at` | string (date-time) |  |
| `via` | string | Example: `sms_phrase`. |
| `method` | `keyword`, `phrase`, `ai`, `api`, `import`, `hosted_page` |  |
| `detected` | string | The keyword or phrase that triggered detection |
| `confidence` | number | Intent-tier detections only, 0 to 1 |
| `campaign_id` | string | On the response to an opt-in recorded for one registration |
| `proof` | OptInProof | Opt-in evidence (Messaging Policy 1.4). Accepted only with status opted_in. |

## 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 |
| 409 | The number opted out, and the opt-in carries no proof collected at or after the opt-out |
| 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

```javascript
import { TextKit } from 'jointextkit'; // npm install jointextkit

const sms = new TextKit(process.env.TEXTKIT_API_KEY);

// Record an opt-out your own system received.
await sms.consent.optOut('+14155550132', { note: 'Asked by phone' });

// Or record an opt-in.
await sms.consent.optIn('+14155550132');
```

### PHP

```php
<?php

$ch = curl_init('https://api.jointextkit.com/v1/consent/+14155550132');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('TEXTKIT_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'status' => 'opted_out',
        'campaign_id' => 'reg_a1B2c3D4e5F6',
    ]),
]);

$data = json_decode(curl_exec($ch), true);
```

### Python

```python
import os
from jointextkit import TextKit  # pip install jointextkit

client = TextKit(os.environ["TEXTKIT_API_KEY"])

# Record an opt-out your own system received.
client.consent.opt_out("+14155550132", note="Asked by phone")

# Or record an opt-in.
client.consent.opt_in("+14155550132")
```

### Ruby

```ruby
require "net/http"
require "json"

uri = URI("https://api.jointextkit.com/v1/consent/+14155550132")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer #{ENV["TEXTKIT_API_KEY"]}"
req["Content-Type"] = "application/json"
req.body = {
  "status": "opted_out",
  "campaign_id": "reg_a1B2c3D4e5F6"
}.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(`{
	  "status": "opted_out",
	  "campaign_id": "reg_a1B2c3D4e5F6"
	}`)
	req, _ := http.NewRequest("POST", "https://api.jointextkit.com/v1/consent/+14155550132", 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<dyn std::error::Error>> {
    let key = std::env::var("TEXTKIT_API_KEY")?;
    let res = reqwest::blocking::Client::new()
        .post("https://api.jointextkit.com/v1/consent/+14155550132")
        .bearer_auth(key)
        .json(&json!({
          "status": "opted_out",
          "campaign_id": "reg_a1B2c3D4e5F6"
        }))
        .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/consent/+14155550132"))
            .header("Authorization", "Bearer " + System.getenv("TEXTKIT_API_KEY"))
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString("""
                {
                  "status": "opted_out",
                  "campaign_id": "reg_a1B2c3D4e5F6"
                }
                """))
            .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("""
    {
      "status": "opted_out",
      "campaign_id": "reg_a1B2c3D4e5F6"
    }
    """, Encoding.UTF8, "application/json");
var res = await http.PostAsync("https://api.jointextkit.com/v1/consent/+14155550132", body);
res.EnsureSuccessStatusCode();

var data = await res.Content.ReadAsStringAsync();
```

### cURL

```bash
curl -X POST "https://api.jointextkit.com/v1/consent/+14155550132" \
  -H "Authorization: Bearer $TEXTKIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "opted_out",
  "campaign_id": "reg_a1B2c3D4e5F6"
}'
```

## Related

- Guide: [Opt-out, consent & TCPA](/docs/opt-out)
- [All consent endpoints](/docs/api#consent)
- [API reference](/docs/api)