postzen-dev · Schema

ContactUpdateRequest

Partial update. profileId cannot be changed; channel fields and unknown keys are rejected with 400 validation. Tags replace the array and customFields replaces the whole object.

Social MediaDeveloper ToolsAI AgentsAutomation

Properties

Name Type Description
name string Trimmed contact name, 1–200 characters.
email stringnull Trimmed lowercase email; unique within its profile. Send null to clear.
company stringnull Company name, at most 200 characters. Send null to clear.
avatarUrl stringnull Public HTTPS avatar URL, canonicalized on PATCH; inbox avatars are stored as supplied by the platform. Send null to clear.
tags array At most 50 tags, trimmed and deduplicated case-insensitively, preserving original case. Send [] to clear.
isSubscribed boolean Contact subscription state. False prevents comment automation sends.
isBlocked boolean Blocked contacts cannot receive comment automation sends.
notes stringnull Free-form notes, at most 5000 characters. Send null to clear.
customFields objectnull At most 50 keys of 1–64 characters. Keys follow Convex record rules: printable ASCII, not starting with $ or _. Values are strings (at most 1000 characters), finite numbers, booleans, or null. PATCH r
View JSON Schema on GitHub

JSON Schema

postzen-dev-contact-update-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/postzen-dev/json-schema/postzen-dev-contact-update-request-schema.json",
  "title": "ContactUpdateRequest",
  "description": "Partial update. profileId cannot be changed; channel fields and unknown keys are rejected with 400 validation. Tags replace the array and customFields replaces the whole object.",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/postzen-dev-openapi.json#/components/schemas/ContactUpdateRequest",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Trimmed contact name, 1–200 characters.",
      "minLength": 1,
      "maxLength": 200
    },
    "email": {
      "type": [
        "string",
        "null"
      ],
      "description": "Trimmed lowercase email; unique within its profile. Send null to clear.",
      "maxLength": 254,
      "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"
    },
    "company": {
      "type": [
        "string",
        "null"
      ],
      "description": "Company name, at most 200 characters. Send null to clear.",
      "maxLength": 200
    },
    "avatarUrl": {
      "type": [
        "string",
        "null"
      ],
      "description": "Public HTTPS avatar URL, canonicalized on PATCH; inbox avatars are stored as supplied by the platform. Send null to clear.",
      "format": "uri",
      "maxLength": 2048
    },
    "tags": {
      "type": "array",
      "description": "At most 50 tags, trimmed and deduplicated case-insensitively, preserving original case. Send [] to clear.",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 50
      },
      "maxItems": 50
    },
    "isSubscribed": {
      "type": "boolean",
      "description": "Contact subscription state. False prevents comment automation sends.",
      "default": true
    },
    "isBlocked": {
      "type": "boolean",
      "description": "Blocked contacts cannot receive comment automation sends.",
      "default": false
    },
    "notes": {
      "type": [
        "string",
        "null"
      ],
      "description": "Free-form notes, at most 5000 characters. Send null to clear.",
      "maxLength": 5000
    },
    "customFields": {
      "type": [
        "object",
        "null"
      ],
      "description": "At most 50 keys of 1–64 characters. Keys follow Convex record rules: printable ASCII, not starting with $ or _. Values are strings (at most 1000 characters), finite numbers, booleans, or null. PATCH replaces the entire object. Send null to clear.",
      "maxProperties": 50,
      "propertyNames": {
        "minLength": 1,
        "maxLength": 64,
        "pattern": "^(?![$_])[\\x20-\\x7e]+$"
      },
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "maxLength": 1000
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          },
          {
            "type": "null"
          }
        ]
      }
    }
  },
  "required": [],
  "additionalProperties": false
}

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/postzen-dev-contact-update-request"
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. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.