Documentation / API / types_opportunity_types

types_opportunity_types

POSThttps://api.oppalerts.com/v1/types/opportunity_types

Lists every opportunity type group with its label and types. Each type has an opportunity_type value and a label.

What it does

The route returns the catalogue of opportunity types. It lists every group with its label and its types. Each type is an opportunity_type value, <group>/<type>, with its label. The content types are in types_content_types.

Use the opportunity_type values in the type_scores field of the index routes. Each item of type_scores is an object with an opportunity_type and its type_score_min, the minimum type score, a whole number from 1 to 100. For example, {"opportunity_type": "advertising/newsletter-ads", "type_score_min": 80}. The tools campaigns_saved_opportunity_add and campaigns_saved_opportunity_update take these values in opportunity_type too.

This route needs no campaign. It is not an index search. It has its own daily count, and the count depends on your plan.

Authentication

Send your token in the Authorization header. See the API overview.

Parameters

This tool has no parameters. Send an empty object.

Strict Rules

  • This tool takes no field. A field that you send is refused. The answer is HTTP 400 with the error code bad_param. The error names the field: "<field> is not a field of this tool."
  • An error about the format of a call, such as a refused field, names the field. Its message ends with one sentence: "Read the documentation at https://oppalerts.com/docs for the correct format." Every other error has only its own sentence.

Response fields

groupslist
Every opportunity group. Each item has the fields below.
groups[].groupstring
The group value, for example advertising.
groups[].labelstring
The name of the group, for example Advertising.
groups[].typeslist
The types of the group. Each item has an opportunity_type value and a label.
groups[].types[].opportunity_typestring
The type as <group>/<type>, for example advertising/newsletter-ads.
groups[].types[].labelstring
The name of the type, for example Newsletter Ads.

Example

Request

curl -X POST https://api.oppalerts.com/v1/types/opportunity_types \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Response

The full sample answer.

{
  "groups": [
    {
      "group": "advertising",
      "label": "Advertising",
      "types": [
        {
          "opportunity_type": "advertising/advertise-with-us",
          "label": "Advertising Media Kits"
        },
        {
          "opportunity_type": "advertising/newsletter-ads",
          "label": "Newsletter Ads"
        }
      ]
    },
    {
      "group": "sponsorship",
      "label": "Sponsorship",
      "types": [
        {
          "opportunity_type": "sponsorship/community-sponsorships",
          "label": "Local Sponsorships"
        },
        {
          "opportunity_type": "sponsorship/sponsors",
          "label": "Sponsorship Packages"
        }
      ]
    }
  ]
}

Errors

  • bad_param (HTTP 400): the request has a field. This route takes no field, and the error names the field that you sent.
  • backend_error (HTTP 502): the data server did not answer, or its answer could not be read. Try again in a few minutes.
  • daily_limit (HTTP 429): the account used all its calls of this tool today. account_calls_left shows when the count resets.

This tool has its own daily count. Calls through the API, MCP, and the web app use this count. It is not an index search, so it does not use the shared count of the news_ and prospects_ tools, and the error one_at_a_time does not apply to it.

Same tool in MCP

The MCP tool is types_opportunity_types. See types_opportunity_types in MCP.