Signals Templates

Signals Templates

Create reusable signal templates to standardize your research questions across multiple companies.

Benefits:

• Consistent research questions across your organization

• Reuse qualification criteria and answer types

• Efficient batch signal creation

• Version control for your research methodology

Workflow:

1. Create a template with your question and criteria

2. Use the template ID when creating signals (or in batch requests)

3. Update templates as needed - changes create new versions

4. Delete templates when no longer needed (soft-delete for history)

Templates support all answer types (text, number, boolean, list, etc.) and qualification criteria to automatically score companies based on their answers.

List signal templates

get

Retrieve a paginated list of signal templates for your organization. Returns the latest active version of each template.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

API key authentication using Bearer token. Format: sk_live_ followed by a secure random string.

Query parameters

limitinteger · min: 1 · max: 100Optional

Maximum number of templates to return

Default: 20

offsetintegerOptional

Number of templates to skip for pagination

Default: 0

includeDeletedbooleanOptional

Include deleted templates in the response

Default: false

Responses

200

Templates retrieved successfully

application/json

401

Unauthorized - Invalid or missing API key

application/json

get

/v1/companies/signals/templates

HTTPcURLJavaScriptPython

GET /v1/companies/signals/templates HTTP/1.1
Host: api.saber.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "e45c1dc4-d422-4b51-956b-cb6d3ddaf250",
      "version": 1,
      "organizationId": "org_123",
      "name": "CRM Detection",
      "description": "Identifies which CRM system a company is using",
      "question": "Which CRM are they using?",
      "answerType": "open_text",
      "outputSchema": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "weight": "important",
      "qualificationCriteria": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "createdByUserId": "user_123",
      "createdAt": "2024-10-14T15:30:00Z",
      "deletedAt": null,
      "source": "api"
    }
  ],
  "total": 10,
  "limit": 20,
  "offset": 0,
  "hasMore": false
}

Create a new signal template

post

Create a reusable signal template that can be referenced when creating signals. Templates allow you to define standard research questions that can be applied to multiple companies.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

API key authentication using Bearer token. Format: sk_live_ followed by a secure random string.

Body

application/json

namestring · min: 1 · max: 200Required

User-friendly name for the template

Example: CRM Detection

descriptionstring · max: 1000Optional

Optional description of what this template does

Example: Identifies which CRM system a company is using

questionstring · min: 1 · max: 500Required

The research question to ask about companies

Example: Which CRM are they using?

answerTypestring · enumOptional

The expected format of the answer

Default: open_textExample: open_textPossible values:

weightstring · enumOptional

The importance/weight of the signal

Example: importantPossible values:

Responses

201

Template created successfully

application/json

400

Bad Request - Invalid parameters

application/json

401

Unauthorized - Invalid or missing API key

application/json

post

/v1/companies/signals/templates

HTTPcURLJavaScriptPython

POST /v1/companies/signals/templates HTTP/1.1
Host: api.saber.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 454

{
  "name": "CRM Detection",
  "description": "Identifies which CRM system a company is using",
  "question": "Which CRM are they using?",
  "answerType": "open_text",
  "outputSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "weight": "important",
  "qualificationCriteria": {
    "ranges": [
      {
        "rangeStart": 0,
        "rangeEnd": 20,
        "answerQualification": "poor"
      },
      {
        "rangeStart": 20,
        "rangeEnd": 50,
        "answerQualification": "neutral"
      },
      {
        "rangeStart": 50,
        "rangeEnd": 100,
        "answerQualification": "excellent"
      }
    ]
  }
}

{
  "id": "e45c1dc4-d422-4b51-956b-cb6d3ddaf250",
  "version": 1,
  "organizationId": "org_123",
  "name": "CRM Detection",
  "description": "Identifies which CRM system a company is using",
  "question": "Which CRM are they using?",
  "answerType": "open_text",
  "outputSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "weight": "important",
  "qualificationCriteria": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdByUserId": "user_123",
  "createdAt": "2024-10-14T15:30:00Z",
  "deletedAt": null,
  "source": "api"
}

Get a signal template

get

Retrieve a specific signal template by ID

Authorizations

ApiKeyAuth

AuthorizationstringRequired

API key authentication using Bearer token. Format: sk_live_ followed by a secure random string.

Path parameters

templateIdstring · uuidRequired

The unique identifier of the template

Responses

200

Template retrieved successfully

application/json

401

Unauthorized - Invalid or missing API key

application/json

404

Template not found

application/json

get

/v1/companies/signals/templates/{templateId}

HTTPcURLJavaScriptPython

GET /v1/companies/signals/templates/{templateId} HTTP/1.1
Host: api.saber.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "e45c1dc4-d422-4b51-956b-cb6d3ddaf250",
  "version": 1,
  "organizationId": "org_123",
  "name": "CRM Detection",
  "description": "Identifies which CRM system a company is using",
  "question": "Which CRM are they using?",
  "answerType": "open_text",
  "outputSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "weight": "important",
  "qualificationCriteria": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdByUserId": "user_123",
  "createdAt": "2024-10-14T15:30:00Z",
  "deletedAt": null,
  "source": "api"
}

Delete a signal template

delete

Soft-delete a signal template. The template will be marked as deleted but preserved for historical tracking.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

API key authentication using Bearer token. Format: sk_live_ followed by a secure random string.

Path parameters

templateIdstring · uuidRequired

The unique identifier of the template to delete

Responses

204

Template deleted successfully (no content returned)

401

Unauthorized - Invalid or missing API key

application/json

404

Template not found

application/json

delete

/v1/companies/signals/templates/{templateId}

HTTPcURLJavaScriptPython

DELETE /v1/companies/signals/templates/{templateId} HTTP/1.1
Host: api.saber.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a signal template

patch

Update a signal template using PATCH semantics (partial update). This creates a new version of the template and soft-deletes the previous version. Only provided fields will be updated; omitted fields will retain their values from the previous version.

The template ID remains the same across all versions. The version number will be incremented.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

API key authentication using Bearer token. Format: sk_live_ followed by a secure random string.

Path parameters

templateIdstring · uuidRequired

The unique identifier of the template to update

Body

application/json

Request body for updating a signal template using PATCH semantics. All fields are optional - only provide the fields you want to update. Omitted fields will retain their values from the previous template version.

namestring · min: 1 · max: 200Optional

User-friendly name for the template

Example: CRM Detection

descriptionstring · max: 1000Optional

Optional description of what this template does

Example: Identifies which CRM system a company is using

questionstring · min: 1 · max: 500Optional

The research question to ask about companies

Example: Which CRM are they using?

answerTypestring · enumOptional

The expected format of the answer

Example: open_textPossible values:

weightstring · enumOptional

The importance/weight of the signal

Example: importantPossible values:

Responses

200

Template updated successfully (new version created)

application/json

400

Bad Request - Invalid parameters

application/json

401

Unauthorized - Invalid or missing API key

application/json

404

Template not found

application/json

patch

/v1/companies/signals/templates/{templateId}

HTTPcURLJavaScriptPython

PATCH /v1/companies/signals/templates/{templateId} HTTP/1.1
Host: api.saber.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 289

{
  "name": "CRM Detection",
  "description": "Identifies which CRM system a company is using",
  "question": "Which CRM are they using?",
  "answerType": "open_text",
  "outputSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "weight": "important",
  "qualificationCriteria": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "id": "e45c1dc4-d422-4b51-956b-cb6d3ddaf250",
  "version": 1,
  "organizationId": "org_123",
  "name": "CRM Detection",
  "description": "Identifies which CRM system a company is using",
  "question": "Which CRM are they using?",
  "answerType": "open_text",
  "outputSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "weight": "important",
  "qualificationCriteria": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdByUserId": "user_123",
  "createdAt": "2024-10-14T15:30:00Z",
  "deletedAt": null,
  "source": "api"
}