signals

Archive Signal

Changed on

Retire a signal: it stops checking and importing, disappears from the default listing, and cannot be resumed until it is unarchived. The destination list and everything already imported are kept. Prefer pausing when the signal should only stop for now.

Requires the signals:write scope on the API key.

post/v1/signals/{signal_id}/archive

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/signals/{signal_id}/archive
  • Auth: HTTP bearer

Path parameters

signal_idstring uuid required

ID of the signal.

Response

Successful Response

idstring uuid required

Unique identifier of the signal.

namestring nullable required

Name of the signal and of its destination list.

signal_type'LINKEDIN_OWN_POST_ENGAGEMENT' | 'LINKEDIN_COMPETITOR_POST_ENGAGEMENT' | 'LINKEDIN_PERSON_POST_ENGAGEMENT' | 'LINKEDIN_KEYWORD_MENTION' | 'LINKEDIN_OWN_COMPANY_FOLLOWERS' | 'LINKEDIN_COMPETITOR_FOLLOWERS' | 'LINKEDIN_COMPANY_PAGE_FOLLOWERS' | 'HIRING_SIGNALS' | 'JOB_DESCRIPTION_KEYWORD' | 'FUNDING_EVENTS' | 'TECH_ADOPTION' | 'NEWS_EVENTS' | 'NEW_JOB' | 'CUSTOM_EVENT' | 'LINKEDIN_PARTNER_FOLLOWERS' | 'LINKEDIN_CUSTOMER_FOLLOWERS' | 'LINKEDIN_PARTNER_POST_ENGAGEMENT' | 'LINKEDIN_CUSTOMER_POST_ENGAGEMENT' | 'LINKEDIN_COMPANY_PAGE_POST_ENGAGEMENT' | 'LINKEDIN_OWN_PROFILE_POST_ENGAGEMENT' | 'LINKEDIN_OWN_EMPLOYEES_POST_ENGAGEMENT' | 'LINKEDIN_COMPETITOR_EMPLOYEES_POST_ENGAGEMENT' | 'LINKEDIN_PARTNER_EMPLOYEES_POST_ENGAGEMENT' | 'LINKEDIN_CUSTOMER_EMPLOYEES_POST_ENGAGEMENT' | 'LINKEDIN_OWN_BRAND_MENTION' | 'LINKEDIN_COMPETITOR_MENTION' | 'LINKEDIN_PARTNER_MENTION' | 'LINKEDIN_CUSTOMER_MENTION' | 'LINKEDIN_EVENT_MENTION' | 'COMPETITOR_TECH_ADOPTION' | 'INTEGRATION_TECH_ADOPTION' | 'LINKEDIN_EVENT_PAGE_FOLLOWERS' | 'CHAMPION_CHANGED_JOB' | 'CRM_LIST_ENTRY' required
status'ACTIVE' | 'PAUSED' | 'ARCHIVED' required
cadence'DAILY' | 'WEEKLY' required
max_per_runinteger nullable required

Daily ceiling on imported entries, when one was set.

max_companies_per_runinteger nullable required

Daily ceiling on detected companies consumed, when one was set.

max_contacts_per_companyinteger nullable required

People imported per detected company, when one was set.

max_per_dayinteger required

Ceiling on the entries the signal imports in one day, resolved from the caps above.

enrich_emailboolean required

Whether imported leads get their email enriched.

enrich_phonesboolean required

Whether imported leads get their phone enriched.

imported_countinteger required

Entries the signal has imported since it was created.

contact_list_idstring uuid nullable required

Destination list, when the signal imports people.

account_list_idstring uuid nullable required

Destination list, when the signal imports companies.

created_atstring date-time required

When the signal was created.

archived_atstring date-time nullable required

When the signal was retired, if it was.

urlstring required

Deep link to the signal in Topo.

list_urlstring nullable required

Deep link to the destination list in Topo.

Changes

  • d037d17aecd4Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 818aee27676cRevision changes
    • warning

      added the new CHAMPION_CHANGED_JOB enum value to the response property for the response status

    • warning

      added the new COMPETITOR_TECH_ADOPTION enum value to the response property for the response status

    • warning

      added the new CRM_LIST_ENTRY enum value to the response property for the response status

    • warning

      added the new INTEGRATION_TECH_ADOPTION enum value to the response property for the response status

    • warning

      added the new LINKEDIN_COMPANY_PAGE_POST_ENGAGEMENT enum value to the response property for the response status

    • warning

      added the new LINKEDIN_COMPETITOR_EMPLOYEES_POST_ENGAGEMENT enum value to the response property for the response status

    • warning

      added the new LINKEDIN_COMPETITOR_MENTION enum value to the response property for the response status

    • warning

      added the new LINKEDIN_CUSTOMER_EMPLOYEES_POST_ENGAGEMENT enum value to the response property for the response status

    • warning

      added the new LINKEDIN_CUSTOMER_FOLLOWERS enum value to the response property for the response status

    • warning

      added the new LINKEDIN_CUSTOMER_MENTION enum value to the response property for the response status

    • warning

      added the new LINKEDIN_CUSTOMER_POST_ENGAGEMENT enum value to the response property for the response status

    • warning

      added the new LINKEDIN_EVENT_MENTION enum value to the response property for the response status

    • warning

      added the new LINKEDIN_EVENT_PAGE_FOLLOWERS enum value to the response property for the response status

    • warning

      added the new LINKEDIN_OWN_BRAND_MENTION enum value to the response property for the response status

    • warning

      added the new LINKEDIN_OWN_EMPLOYEES_POST_ENGAGEMENT enum value to the response property for the response status

    • warning

      added the new LINKEDIN_OWN_PROFILE_POST_ENGAGEMENT enum value to the response property for the response status

    • warning

      added the new LINKEDIN_PARTNER_EMPLOYEES_POST_ENGAGEMENT enum value to the response property for the response status

    • warning

      added the new LINKEDIN_PARTNER_FOLLOWERS enum value to the response property for the response status

    • warning

      added the new LINKEDIN_PARTNER_MENTION enum value to the response property for the response status

    • warning

      added the new LINKEDIN_PARTNER_POST_ENGAGEMENT enum value to the response property for the response status