POST /portfolio_company_profiles
Bearer auth

Create a new portfolio company profile in your account.

application/json

Body Required

  • portfolio_company_profile object
    Hide portfolio_company_profile attributes Show portfolio_company_profile attributes object
    • name string Required

      Unique name of the portfolio company profile

    • website_url string | null

      Website URL of the portfolio company profile

    • currency string | null

      Currency code (ISO 4217) for the portfolio company profile

    • company_id string(uuid) Required

      ID of the company or fund

    • primary_contact_id string | null

      ID of the primary contact for the portfolio company profile

Responses

  • 201 application/json

    Portfolio company profile successfully created

    Hide response attribute Show response attribute object
    • portfolio_company_profile object
      Hide portfolio_company_profile attributes Show portfolio_company_profile attributes object
      • id string(uuid) Required

        Unique identifier for the portfolio company profile

      • name string Required

        Unique name of the portfolio company profile

      • website_url string | null Required

        Website URL of the portfolio company profile

      • currency string | null Required

        Currency code (ISO 4217) for the portfolio company profile

      • created_at string(date-time) Required

        When the portfolio company profile was created

      • company_id string(uuid) Required

        ID of the company or fund

      • primary_contact_id string | null Required

        ID of the primary contact for the portfolio company profile
  • 400 application/json

    Bad Request - The request is invalid or malformed

    Hide response attribute Show response attribute object
    • errors array[object] Required

      Single error item. Different error types can include different fields.

      Hide errors attributes Show errors attributes object
      • type string

        Machine-readable error type

      • field string

        The related field, if applicable

      • message string

        Human-readable error message
  • 401 application/json

    Unauthorized - Invalid or missing authentication token

    Hide response attribute Show response attribute object
    • errors array[object] Required

      Single error item. Different error types can include different fields.

      Hide errors attributes Show errors attributes object
      • type string

        Machine-readable error type

      • field string

        The related field, if applicable

      • message string

        Human-readable error message
  • 422 application/json

    Unprocessable Entity - The request is valid but contains semantic errors

    Hide response attribute Show response attribute object
    • errors array[object] Required

      Single error item. Different error types can include different fields.

      Hide errors attributes Show errors attributes object
      • type string

        Machine-readable error type

      • field string

        The related field, if applicable

      • message string

        Human-readable error message
  • 429 application/json

    Too Many Requests - Rate limit exceeded

    Hide response attribute Show response attribute object
    • errors array[object] Required

      Single error item. Different error types can include different fields.

      Hide errors attributes Show errors attributes object
      • type string

        Machine-readable error type

      • field string

        The related field, if applicable

      • message string

        Human-readable error message
POST /portfolio_company_profiles 
curl \
 --request POST 'https://api.visible.vc/portfolio_company_profiles' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"portfolio_company_profile":{"name":"Portfolio company 1","currency":"USD","company_id":"cad09a10-73e8-4205-ae67-4e6156f37be8","website_url":"https://www.example.com","primary_contact_id":"b9bd9bb5-9b12-48bb-ae93-cdd2eba9af98"}}'
Request example 
{
  "portfolio_company_profile": {
    "name": "Portfolio company 1",
    "currency": "USD",
    "company_id": "cad09a10-73e8-4205-ae67-4e6156f37be8",
    "website_url": "https://www.example.com",
    "primary_contact_id": "b9bd9bb5-9b12-48bb-ae93-cdd2eba9af98"
  }
}
Response examples (201) 
{
  "portfolio_company_profile": {
    "id": "ec5252fe-9abc-4096-85e9-1374e70a3182",
    "name": "Portfolio company 1",
    "currency": "USD",
    "company_id": "cad09a10-73e8-4205-ae67-4e6156f37be8",
    "created_at": "2023-02-01T22:08:21.175Z",
    "website_url": "https://www.example.com",
    "primary_contact_id": "b9bd9bb5-9b12-48bb-ae93-cdd2eba9af98"
  }
}
Response examples (400) 
{
  "errors": [
    {
      "type": "parameter_invalid",
      "field": "filter",
      "message": "must be an object"
    }
  ]
}
Response examples (401) 
{
  "errors": [
    {
      "type": "unauthorized"
    }
  ]
}
Response examples (422) 
{
  "errors": [
    {
      "type": "attribute_invalid",
      "field": "value",
      "message": "required"
    }
  ]
}
Response examples (429) 
{
  "errors": [
    {
      "type": "rate_limit_exceeded"
    }
  ]
}