Create Pursuit

Create_Pursuit creates a new GovTribe pursuit in a specific stage and returns the created pursuit resource as JSON text.

Input Contract

  • stage_id: GovTribe ID of the stage that will contain the new pursuit.

    • type: string

    • required: yes

    • default: n/a

  • name: Pursuit name; required unless both linked-item fields are provided together.

    • type: string

    • required: conditional

    • default: n/a when no linked item is supplied

    • shape: min length 1, max length 255

  • linked_item_model_class: Optional model class used to seed the pursuit from an existing GovTribe record.

    • type: string enum

    • required: conditional (required with linked_item_id when name is omitted)

    • default: omit

    • options: ContactGroupModel, ContactModel, FederalContractAwardModel, FederalContractIDVModel, FederalContractOpportunityModel, FederalForecastModel, FederalGrantAwardModel, FederalGrantOpportunityModel, FederalGrantProgramModel, JurisdictionModel, NIGPCategoryModel, StateLocalContractOpportunityModel, StateLocalContractAwardModel, StateLocalContractIDVModel, StateLocalContractVehicleModel, UNSPSCCategoryModel, FederalAgencyModel, FederalContractVehicleModel, NAICSCategoryModel, PSCCategoryModel, StateModel

  • linked_item_id: GovTribe ID of the linked item used for seeding.

    • type: string

    • required: conditional (required with linked_item_model_class when name is omitted)

    • default: omit

  • description: Optional pursuit description text.

    • type: string

    • required: no

    • default: omit

    • shape: min length 0

  • pwin: Optional probability of win value.

    • type: integer

    • required: no

    • default: omit

    • shape: min 1, max 100

  • estimatedValue: Optional estimated pursuit value.

    • type: integer

    • required: no

    • default: omit

    • shape: min 0

  • estimatedDuration: Optional estimated performance duration in months.

    • type: integer

    • required: no

    • default: omit

    • shape: min 0

  • estimatedAwardDate: Optional expected award date.

    • type: string

    • required: no

    • default: omit

    • shape: YYYY-MM-DD

  • dueDate: Optional response due date.

    • type: string

    • required: no

    • default: omit

    • shape: YYYY-MM-DD or ISO 8601

Output Contract

  • Top-level keys:

    • govtribe_id

    • govtribe_ai_summary

    • govtribe_type

    • govtribe_url

    • name

    • description

    • due_date

    • created_at

    • estimated_award_date

    • estimated_duration

    • set_aside

    • estimated_value

    • updated_at

    • owner

    • stage

    • pipeline

    • user_files

    • federal_agency

    • naics_category

    • psc_category

    • state

    • associated_records

    • contacts

  • Row keys:

    • n/a

  • Relationship retrieval map:

    • associated_records

      • resource_type: federal_contract_award

      • tool: Search_Federal_Contract_Awards

      • filter: contact_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

      • resource_type: federal_contract_idv

      • tool: Search_Federal_Contract_IDVs

      • filter: contact_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

      • resource_type: federal_contract_opportunity

      • tool: Search_Federal_Contract_Opportunities

      • filter: contact_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

      • resource_type: federal_forecast

      • tool: Search_Federal_Forecasts

      • filter: contact_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

      • resource_type: federal_grant_award

      • tool: Search_Federal_Grant_Awards

      • filter: contracting_federal_agency_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

      • resource_type: federal_grant_opportunity

      • tool: Search_Federal_Grant_Opportunities

      • filter: contact_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

      • resource_type: nigp_category

      • tool: Search_Nigp_Categories

      • filter: nigp_category_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

      • resource_type: state_local_contract_award

      • tool: Search_State_And_Local_Contract_Awards

      • filter: contact_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

      • resource_type: state_local_contract_idv

      • tool: Search_State_And_Local_Contract_IDVs

      • filter: contact_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

      • resource_type: state_local_contract_opportunity

      • tool: Search_State_And_Local_Contract_Opportunities

      • filter: contact_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

      • resource_type: state_local_contract_vehicle

      • tool: Search_State_And_Local_Contract_Vehicles

      • filter: contact_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

      • resource_type: unspsc_category

      • tool: Search_Unspsc_Categories

      • filter: unspsc_category_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

    • contacts

      • resource_type: contact

      • tool: Search_Contacts

      • filter: contact_ids

      • nested_keys: govtribe_id, govtribe_type, name, email, govtribe_url

    • federal_agency

      • resource_type: federal_agency

      • tool: Search_Federal_Agencies

      • filter: federal_agency_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

    • naics_category

      • resource_type: naics_category

      • tool: Search_Naics_Categories

      • filter: naics_category_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

    • owner

      • resource_type: user

      • tool: Search_Users

      • filter: user_ids

      • nested_keys: govtribe_id, govtribe_type, name, email

    • pipeline

      • resource_type: pipeline

      • tool: Search_Pipelines

      • filter: creator_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

    • psc_category

      • resource_type: psc_category

      • tool: Search_Psc_Categories

      • filter: psc_category_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

    • stage

      • resource_type: stage

      • tool: Search_Stages

      • filter: creator_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name, type

    • state

      • resource_type: state

      • tool: Search_States

      • filter: state_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

    • user_files

      • resource_type: user_file

      • tool: Search_User_Files

      • filter: user_file_ids

      • nested_keys: govtribe_id, govtribe_type, govtribe_url, name

Usage Patterns

Pattern A: Create a manual pursuit with required fields only. Tool: Create_Pursuit

Pattern B: Create a pursuit seeded from a federal contract opportunity. Tool: Create_Pursuit

Pattern C: Create from a linked item and set forecasting fields at creation time. Tool: Create_Pursuit

Pattern D: Create a manual pursuit with schedule and probability fields for pipeline forecasting. Tool: Create_Pursuit

Last updated

Was this helpful?