PortalConnection

object

connection_idrequired: Id
Opaque record id.
portalrequired: "99acres" | "magicbricks" | "housing" | "justdial" | "sulekha" | "commonfloor"
namerequired: string or null
statusrequired: string
healthrequired: "ok" | "degraded" | "error" | "disconnected" | "pending"
source_idrequired: Id or null
Opaque record id.
push_urlrequired: string or null
The URL the portal calls (secret).
pullrequired: object or null
pull.enabledrequired: boolean
pull.interval_minutesrequired: integer
pull.overlap_minutesrequired: integer
pull.endpointrequired: string or null
syncrequired: object or null
sync.cursorrequired: string or null
sync.last_run_atrequired: string or null
sync.last_statusrequired: "ok" | "error" | "auth" or null
sync.last_countrequired: integer
sync.last_errorrequired: string or null
sync.reconcilerequired: object
The nightly 48-hour reconciliation pull of a push-first connection.
sync.reconcile.last_atrequired: string or null
sync.reconcile.last_onrequired: string or null
sync.reconcile.statusrequired: "ok" | "error" | "auth" | "skipped" or null
sync.reconcile.storedrequired: integer
sync.reconcile.errorrequired: string or null
credentialsrequired: object
credentials.has_secretrequired: boolean
credentials.fieldsrequired: array of string
credentials.hintsrequired: map of string
activationrequired: object
API activation steps; leads move the later steps.
activation.statusrequired: "not_requested" | "requested" | "waiting_for_portal" | "test_lead_received" | "live"
activation.requested_atrequired: string or null
activation.requested_byrequired: string or null
activation.waiting_atrequired: string or null
activation.test_lead_atrequired: string or null
activation.live_atrequired: string or null
activation.reminded_atrequired: string or null
project_maprequired: array of object
Portal project id → PropZolo project.
project_map[].portal_project_idrequired: string
project_map[].project_idrequired: Id
Opaque record id.
package_ends_onrequired: string (date) or null
Last day of the portal package (company calendar).
allowed_ips: array of string
Push callers allowed by IP address or CIDR block; empty = any caller.
last_ok_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
last_errorrequired: string or null
error_countrequired: integer
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
onboardingrequired: object or null
The pre-written email to the account manager and a sandbox test link (managers only).
onboarding.email_subjectrequired: string
onboarding.email_bodyrequired: string
onboarding.mailtorequired: string
onboarding.test_urlrequired: string or null

Example

{
  "connection_id": "cmusrceel0000q7kaafxqi1om",
  "portal": "99acres",
  "name": "string",
  "status": "string",
  "health": "ok",
  "source_id": "cmusrceel0000q7kaafxqi1om",
  "push_url": "string",
  "pull": {
    "enabled": true,
    "interval_minutes": 0,
    "overlap_minutes": 0,
    "endpoint": "string"
  },
  "sync": {
    "cursor": "string",
    "last_run_at": "string",
    "last_status": "ok",
    "last_count": 0,
    "last_error": "string",
    "reconcile": {
      "last_at": "string",
      "last_on": "string",
      "status": "ok",
      "stored": 0,
      "error": "string"
    }
  },
  "credentials": {
    "has_secret": true,
    "fields": [
      "string"
    ],
    "hints": {}
  },
  "activation": {
    "status": "not_requested",
    "requested_at": "string",
    "requested_by": "string",
    "waiting_at": "string",
    "test_lead_at": "string",
    "live_at": "string",
    "reminded_at": "string"
  },
  "project_map": [
    {
      "portal_project_id": "string",
      "project_id": "cmusrceel0000q7kaafxqi1om"
    }
  ],
  "package_ends_on": "2026-10-06",
  "allowed_ips": [
    "string"
  ],
  "last_ok_at": "2026-10-06T05:30:00.000Z",
  "last_error": "string",
  "error_count": 0,
  "created_at": "2026-10-06T05:30:00.000Z",
  "onboarding": {
    "email_subject": "string",
    "email_body": "string",
    "mailto": "string",
    "test_url": "string"
  }
}

{ "connection_id": "cmusrceel0000q7kaafxqi1om", "portal": "99acres", "name": "string", "status": "string", "health": "ok", "source_id": "cmusrceel0000q7kaafxqi1om", "push_url": "string", "pull": { "enabled": true, "interval_minutes": 0, "overlap_minutes": 0, "endpoint": "string" }, "sync": { "cursor": "string", "last_run_at": "string", "last_status": "ok", "last_count": 0, "last_error": "string", "reconcile": { "last_at": "string", "last_on": "string", "status": "ok", "stored": 0, "error": "string" } }, "credentials": { "has_secret": true, "fields": [ "string" ], "hints": {} }, "activation": { "status": "not_requested", "requested_at": "string", "requested_by": "string", "waiting_at": "string", "test_lead_at": "string", "live_at": "string", "reminded_at": "string" }, "project_map": [ { "portal_project_id": "string", "project_id": "cmusrceel0000q7kaafxqi1om" } ], "package_ends_on": "2026-10-06", "allowed_ips": [ "string" ], "last_ok_at": "2026-10-06T05:30:00.000Z", "last_error": "string", "error_count": 0, "created_at": "2026-10-06T05:30:00.000Z", "onboarding": { "email_subject": "string", "email_body": "string", "mailto": "string", "test_url": "string" } }