Create a Contact

POST /contacts
Bearer auth

Create contacts in your Visible account.

If you don't know your company ID you can get it from the URL in the app: https://app.visible.vc/companies/{company_id}.

application/json

Body Required

  • contact object
    Hide contact attributes Show contact attributes object
    • email string(email) Required

      Email address of the contact

    • company_id string(uuid) Required

      ID of the company or fund

    • first_name string

      First name of the contact

    • last_name string

      Last name of the contact

    • title string

      Job title of the contact

    • contact_list_ids array[string(uuid)]

      Array of contact list IDs this contact should belong to

      Default value is [] (empty).

Responses

  • 201 application/json

    Contact successfully created

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

        Unique identifier for the contact

      • email string(email) Required

        Email address of the contact

      • company_id string(uuid) Required

        ID of the company or fund

      • first_name string | null

        First name of the contact

      • last_name string | null

        Last name of the contact

      • title string | null

        Job title of the contact

      • contact_list_ids array[string(uuid)] Required

        Array of contact list IDs this contact belongs to
  • 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 /contacts 
curl \
 --request POST 'https://api.visible.vc/contacts' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"contact":{"email":"test@example.com","title":"CEO","last_name":"Doe","company_id":"c85cb869-40c0-4b8f-829a-30cdeb673ce0","first_name":"Jane","contact_list_ids":[]}}'
Request example 
{
  "contact": {
    "email": "test@example.com",
    "title": "CEO",
    "last_name": "Doe",
    "company_id": "c85cb869-40c0-4b8f-829a-30cdeb673ce0",
    "first_name": "Jane",
    "contact_list_ids": []
  }
}
Response examples (201) 
{
  "contact": {
    "id": "b9bd9bb5-9b12-48bb-ae93-cdd2eba9af98",
    "email": "test@example.com",
    "title": "CEO",
    "last_name": "Doe",
    "company_id": "c85cb869-40c0-4b8f-829a-30cdeb673ce0",
    "first_name": "Jane",
    "contact_list_ids": []
  }
}
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"
    }
  ]
}