OptOut
An opt-out record as stored: field names are camelCase, unlike the rest of the API.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | |
| accountId | string | |
| channel | string | |
| phoneNumber | stringnull | |
| fromNumber | stringnull | The sending number the subscriber opted out from (SMS). |
| fromAddress | stringnull | |
| emailAddress | stringnull | |
| keywordUsed | stringnull | STOP, UNSUBSCRIBE and so on; null for an opt-out recorded through the API. |
| optedOutAt | string | |
| reinstatedAt | stringnull | |
| reinstateKeyword | stringnull |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/honkio-ca/json-schema/honkio-ca-opt-out-schema.json",
"title": "OptOut",
"description": "An opt-out record as stored: field names are camelCase, unlike the rest of the API.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/honkio-ca-compliance-casl-api-openapi.yml#/components/schemas/OptOut",
"type": "object",
"additionalProperties": true,
"required": [
"id",
"accountId",
"channel",
"phoneNumber",
"fromNumber",
"fromAddress",
"emailAddress",
"keywordUsed",
"optedOutAt",
"reinstatedAt",
"reinstateKeyword"
],
"properties": {
"id": {
"type": "string"
},
"accountId": {
"type": "string"
},
"channel": {
"type": "string",
"enum": [
"SMS",
"EMAIL"
]
},
"phoneNumber": {
"type": [
"string",
"null"
]
},
"fromNumber": {
"type": [
"string",
"null"
],
"description": "The sending number the subscriber opted out from (SMS)."
},
"fromAddress": {
"type": [
"string",
"null"
]
},
"emailAddress": {
"type": [
"string",
"null"
]
},
"keywordUsed": {
"type": [
"string",
"null"
],
"description": "STOP, UNSUBSCRIBE and so on; null for an opt-out recorded through the API."
},
"optedOutAt": {
"type": "string",
"format": "date-time"
},
"reinstatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"reinstateKeyword": {
"type": [
"string",
"null"
]
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
curl "https://apis.io/api/v1/json-schemas/honkio-ca-opt-out"
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.