Skip to main content

Create company signal monitor

Save a reusable named monitor definition before attaching Company selections.

POST/api/sales-signals/monitors
HTTP referenceScope (signals:read OR companies:read) AND (signals:read OR companies:write) AND (signals:write OR companies:read) AND (signals:write OR companies:write)Updated October 19, 2026

This page documents the canonical HTTP contract for this endpoint.

Developer keys need signals:read and signals:write, or the complete legacy combination of companies:read and companies:write. Signals scopes do not grant general CRM or Search access.

This reference describes the current source contract. Verify the selected server’s deployed behavior and provider readiness separately; publishing documentation does not enable monitoring.

Returns HTTP 201 with {monitor}, including its ID and revision. Creating a monitor does not attach Companies or retrieve posts. Follow attachment preview and attach with the exact returned monitor ID. The Companies UI uses this reusable-definition workflow.

LinkedIn posts: use provider=harvest_linkedin with signalTypes=["linkedin_posts"]. The provider normalizes the effective schedule to frequency=daily, lookbackDays=1, and an empty provider window. The monitored source is posts or reposts by people associated with the company; official company-page posts are excluded.

Compatibility: existing API configurations can retain legacy LinkedIn relevance fields. They are not current monitor inputs; omit them from new requests to use the default behavior.

Delivery credits

Saving subscriptions and monitor definitions is free. Read the monitors catalog for deliveryBillingPolicy. When enabled=true, delivery costs one organization credit per unique signal delivered to that organization. Empty checks, duplicate delivery, provider retries, and additional Company associations for the same already-visible signal do not create another delivery charge.

If organization credits are insufficient, delivery is held: the new event or organization link, scoring, and webhook are not published for that delivery. While billing is enabled, the scheduler can recover held delivery after credits become available using stored evidence, without purchasing the provider result again. Enrollment success and scheduled-check counts do not confirm paid delivery.

The source billing flag defaults to false. The selected server’s returned deliveryBillingPolicy.enabled determines whether this policy is enabled there; documentation publication does not activate billing.

Body parameters

  • name · optional

    string

    Reusable display name, at most 120 characters; the server derives one when omitted.

  • provider · optional

    string

    signalbase (default), autotouch_jobs for hiring, or harvest_linkedin for LinkedIn employee posts. The default provider also routes mixed selected families to their owning providers.

  • signalTypesrequired

    array<string>

    At least one signal family; use ["linkedin_posts"] for this example.

  • enabled · optional

    boolean

    Create active subscriptions when true (default), paused when false.

  • frequency · optional

    string

    Generic default weekly; the LinkedIn provider normalizes it to daily.

  • lookbackDays · optional

    integer

    1–90 in the request; LinkedIn normalizes it to 1 day.

  • deliveryChannels · optional

    array<string>

    Optional saved delivery-channel configuration.

  • window · optional

    object

    Optional provider window; normalized to {} for LinkedIn posts.

  • activeUntil · optional

    date-time

    Optional monitoring end time.

  • config · optional

    object

    Optional provider compatibility data. Omit for default behavior.

Errors

StatusMeaning
400Invalid Companies selection.
401Missing or invalid authentication or user context.
403The developer key lacks the listed Signals or complete legacy Company scopes.
404No companies matched, or the organization-scoped monitor was not found.
422Unsupported provider, signal family, filter field/value, or invalid request.

Docs