Ometria · Schema

Unsubscribes

Describes an Unsubscribe record.

CompanyRetailCustomer Data PlatformArtificial IntelligenceMarketing

Properties

Name Type Description
profile_id string The profile id of the contact whom has unsubscribed.
email_address string The email address of the contact whom has unsubscribed.
type string The type of unsubscribe event. This indicates where the contact unsubscribed (e.g., "preferences_centre").
timestamp string The timestamp of the unsubscribe event.
reason string The reason given for unsubscribing.
reason_text string The reason provided for unsubscribing in the free-text field.
customer_id string The universal customer ID for this contact.
View JSON Schema on GitHub

JSON Schema

ometria-unsubscribes-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ometria/json-schema/ometria-unsubscribes-schema.json",
  "title": "Unsubscribes",
  "description": "Describes an Unsubscribe record.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ometria-unsubscribes-api-openapi.yml#/components/schemas/Unsubscribes",
  "type": "object",
  "properties": {
    "profile_id": {
      "type": "string",
      "description": "The profile id of the contact whom has unsubscribed."
    },
    "email_address": {
      "type": "string",
      "description": "The email address of the contact whom has unsubscribed."
    },
    "type": {
      "type": "string",
      "description": "The type of unsubscribe event. This indicates where the contact unsubscribed (e.g., \"preferences_centre\").",
      "enum": [
        "preferences_centre",
        "app",
        "list_unsubscribe",
        "link_unsubscribe",
        "stopword_unsubscribe_TF",
        "stopword_unsubscribe_DO"
      ]
    },
    "timestamp": {
      "type": "string",
      "format": "date-time",
      "description": "The timestamp of the unsubscribe event."
    },
    "reason": {
      "type": "string",
      "description": "The reason given for unsubscribing."
    },
    "reason_text": {
      "type": "string",
      "description": "The reason provided for unsubscribing in the free-text field."
    },
    "customer_id": {
      "type": "string",
      "description": "The universal customer ID for this contact."
    }
  }
}

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.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/ometria-unsubscribes"
All schemas
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.