---
title: "Opt In Recipient"
method: POST
path: "/api/v1/phone/sms-opt-ins/{receiver_number}/opt-in"
tags: ["SMS Opt-Ins"]
---

# Opt In Recipient

`POST /api/v1/phone/sms-opt-ins/{receiver_number}/opt-in`

## Request

- Base URL: `https://api.inkbox.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.inkbox.ai/api/v1/phone/sms-opt-ins/{receiver_number}/opt-in`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

## Path parameters

- `receiver_number` string, required: Recipient phone number in E.164 format (e.g. +15551234567).

## Response `200`

Successful Response

- SmsOptInResponse
  - `id` string, uuid, required
  - `organization_id` string, required
  - `receiver_number` string, required
  - `status` 'opted_in' | 'opted_out', required
  - `source` 'sms' | 'api', required
  - `opted_in_at` string, date-time, nullable, required
  - `opted_out_at` string, date-time, nullable, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `422`: Validation Error
- `4XX`: Client error with Support Agent information.
- `5XX`: Server error with Support Agent information.

---

[API](https://skmtc.dev/inkbox/apis/inkbox-api.md) - [All operations](https://skmtc.dev/inkbox/apis/inkbox-api/llms.txt) - [OpenAPI document](https://skmtc.dev/inkbox/apis/inkbox-api/revisions/3e862146bf53?raw)