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

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

`POST /v1/consent/{phone}`

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. |
| `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` |
| 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` |  |
| `detected` | string | The keyword or phrase that triggered detection |
| `confidence` | number | AI-tier detections only, 0 to 1 |

## 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 |
| 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

### curl

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

### Node.js

```javascript
import { SimpleSMS } from 'joinsimplesms'; // npm install joinsimplesms

const sms = new SimpleSMS(process.env.SIMPLESMS_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');
```

### Python

```python
import os
from joinsimplesms import SimpleSMS  # pip install joinsimplesms

client = SimpleSMS(os.environ["SIMPLESMS_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")
```

## Related

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