Zernio
Zernio
API Reference

Contacts

List contactsGETCreate contactPOSTList channels for a contactGETGet contactGETUpdate contactPATCHDelete contactDELETEBulk create contactsPOST
Dashboard
llms.txtOpenAPI
OverviewPlatformsAPI ReferenceResources
Contacts

Create contact

Create a new contact. Optionally create a platform channel in the same request by providing accountId, platform, and platformIdentifier.

POST
/v1/contacts

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

{  "success": true,  "contact": {    "id": "string",    "name": "string",    "email": "string",    "company": "string",    "tags": [      "string"    ],    "isSubscribed": true,    "isBlocked": true,    "customFields": {},    "notes": "string",    "createdAt": "2019-08-24T14:15:22Z"  },  "channel": {    "id": "string",    "platform": "string",    "platformIdentifier": "string",    "displayIdentifier": "string"  },  "warning": "string"}
Was this page helpful?

List contacts

List and search contacts for a profile. Supports filtering by tags, platform, subscription status, and text search on name, email and company.

List channels for a contact

Returns all messaging channels linked to a contact (e.g. Instagram DM, Telegram, WhatsApp).

profileId*string
name*string
email?string
company?string
tags?array<string>
isSubscribed?boolean
Defaulttrue
notes?string
accountId?string

Optional. Creates a channel if provided with platform + platformIdentifier

platform?string

Channel platform. Only the enum values support contact channels; any other platform is rejected with code platform_not_supported.

Value in

  • "instagram"
  • "facebook"
  • "telegram"
  • "twitter"
  • "bluesky"
  • "reddit"
  • "whatsapp"
  • "slack"
  • "sms"
platformIdentifier?string
displayIdentifier?string