> ## Documentation Index > Fetch the complete documentation index at: https://docs.useroulette.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a company > Update company information. Only include fields you want to change. ## OpenAPI ````yaml openapi.json patch /companies/{id} openapi: 3.1.0 info: title: Roulette API version: 1.0.0 description: > The Roulette API provides programmatic access to manage your VC deal flow, companies, contacts, and related data. ## Authentication All API requests require authentication using a Bearer token. Include your API key in the `Authorization` header: ``` Authorization: Bearer YOUR_API_KEY ``` You can generate API keys from your account settings in the Roulette dashboard. ## Rate Limiting API requests are rate limited to ensure fair usage. Current limits: - 1000 requests per minute per API key - 100 requests per second per API key Rate limit headers are included in all responses: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Requests remaining in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Pagination List endpoints support cursor-based pagination using the following query parameters: - `page`: Page number (default: 1) - `limit`: Items per page (default: 25, max: 100) Paginated responses include pagination metadata: ```json { "data": [...], "pagination": { "page": 1, "limit": 25, "has_next": true, "has_prev": false } } ``` **Note**: For performance reasons, total counts (`total`, `total_pages`) are not included. Use `has_next` and `has_prev` to determine if more pages exist. ## Errors The API uses standard HTTP status codes and returns errors in a consistent format: ```json { "success": false, "error": "Human readable error message", "data": null } ``` Common status codes: - `400` Bad Request - Invalid parameters or request body - `401` Unauthorized - Missing or invalid API key - `403` Forbidden - Valid API key but insufficient permissions - `404` Not Found - Resource not found - `429` Too Many Requests - Rate limit exceeded - `500` Internal Server Error - Server-side error termsOfService: https://www.useroulette.com/terms contact: name: Roulette API Support email: support@useroulette.com url: https://www.useroulette.com/support license: name: Proprietary url: https://www.useroulette.com/license servers: - url: https://www.useroulette.com/api/v1 description: Production server - url: http://localhost:3000/api/v1 description: Local development server security: - BearerAuth: [] tags: - name: Companies description: > Manage companies in your deal flow pipeline. Companies represent potential investment opportunities with associated pitch decks, contacts, and metadata. - name: Company Statuses description: | Manage deal flow stages/statuses for organizing companies through your investment pipeline (e.g., "Initial Review", "Due Diligence", "Closed"). - name: Company Settings description: | Configure custom fields and settings for company tracking. - name: Contacts description: | Manage contacts associated with companies, including founders, executives, and other key personnel. - name: Form Submissions description: | Access form submissions from integrated platforms like Tally. - name: Emails description: | Manage emails linked to companies and contacts. - name: Meeting Minutes description: | Store and retrieve meeting notes and minutes related to companies. - name: Shared Links description: | Create and manage secure shareable links for company portfolios. - name: Integrations description: | Configure third-party integrations (Tally, Specter, etc.). - name: Investor Dashboard description: | Configure and manage investor-facing portfolio dashboards. - name: Dashboard description: | Access aggregated dashboard data and analytics. - name: Team Members description: | View team members and their roles within your account. - name: Short URLs description: | Create shortened URLs with optional password protection. paths: /companies/{id}: patch: tags: - Companies summary: Update a company description: | Update company information. Only include fields you want to change. operationId: updateCompany parameters: - $ref: '#/components/parameters/CompanyIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CompanyUpdate' example: name: Acme Corp (Updated) company_status_id: status-uuid-here metadata: user_preferences: - type: select field: Industry value: AI/ML options: - SaaS - Fintech - AI/ML - Developer Tools show_in_table: true responses: '200': description: Company updated successfully content: application/json: schema: $ref: '#/components/schemas/CompanyResponse' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '404': $ref: '#/components/responses/NotFoundError' '500': $ref: '#/components/responses/InternalServerError' components: parameters: CompanyIdParam: name: id in: path required: true description: The unique identifier of the company schema: type: string format: uuid example: 7c9e6679-7425-40de-944b-e07fc1f90ae7 schemas: CompanyUpdate: type: object description: All fields are optional for partial updates properties: name: type: string maxLength: 255 deck_link: type: string format: uri nullable: true notes: type: string nullable: true company_status_id: type: string format: uuid nullable: true visibility: type: string enum: - private - shared - team source: type: string enum: - manual - email - form - referral - website - event - other metadata: $ref: '#/components/schemas/CompanyMetadata' CompanyResponse: type: object required: - success - data properties: success: type: boolean example: true data: type: object required: - company properties: company: $ref: '#/components/schemas/Company' pdf_download_url: type: string format: uri description: Signed URL for downloading the pitch deck PDF (if requested) authType: type: string enum: - api_key - session CompanyMetadata: type: object description: > Custom metadata for the company. Contains AI-extracted data, founder info, and user-configurable custom fields. properties: founders: type: array description: >- Founder/team member information (typically AI-extracted from pitch deck) items: $ref: '#/components/schemas/Founder' ai_analysis: type: string nullable: true description: AI-generated company description/summary example: >- B2B SaaS platform providing enterprise workflow automation with AI-powered document processing. analyzed_at: type: string format: date-time nullable: true description: When the AI analysis was performed example: '2024-01-15T12:45:00Z' user_preferences: type: array description: Custom fields configured by the account for tracking company data items: $ref: '#/components/schemas/UserPreference' additionalProperties: true Company: type: object required: - id - account_id - created_at - updated_at properties: id: type: string format: uuid description: Unique identifier for the company example: a1b2c3d4-e5f6-7890-abcd-ef1234567890 account_id: type: string format: uuid description: Account/team this company belongs to example: 11111111-2222-3333-4444-555555555555 name: type: string description: Company name example: Acme Technologies maxLength: 255 deck_link: type: string format: uri nullable: true description: URL to the pitch deck (external link or storage URL) example: https://docsend.com/view/example123 deck_storage_path: type: string nullable: true description: Internal storage path for uploaded pitch deck example: companies/7c9e6679/deck.pdf visibility: type: string enum: - private - shared - team description: | Visibility level: - `private`: Only visible to the creator - `shared`: Visible to specific users via company_shared_access - `team`: Visible to all team members default: team example: team source: type: string enum: - manual - email - form - referral - website - event - other nullable: true description: How the company was added to the pipeline example: form source_content: type: string nullable: true description: | Raw source content when company was created from a form submission. Contains the original form field data in a serialized format. example: >- 0: {"key":"question_wbB2ze","type":"INPUT_EMAIL","label":"Email","value":"founder@company.com"} notes: type: string nullable: true description: Internal notes about the company (not visible to the company) example: Met at TechCrunch Disrupt. Strong technical team. company_status_id: type: string format: uuid nullable: true description: Current deal flow status ID example: a1b2c3d4-e5f6-7890-abcd-ef1234567890 company_status: nullable: true description: Embedded company status object (when joined) allOf: - $ref: '#/components/schemas/CompanyStatus' metadata: $ref: '#/components/schemas/CompanyMetadata' metadata_search_text: type: string nullable: true description: Flattened metadata for full-text search (auto-generated) assignees: type: array description: List of team members assigned to this company items: $ref: '#/components/schemas/Assignee' default: [] created_by: type: string format: uuid nullable: true description: User ID who created this company record example: user-uuid-1234 updated_by: type: string format: uuid nullable: true description: User ID who last updated this company record example: user-uuid-1234 created_at: type: string format: date-time description: When the company was created example: '2024-01-15T10:30:00Z' updated_at: type: string format: date-time description: When the company was last updated example: '2024-01-15T12:45:00Z' Error: type: object required: - success - error properties: success: type: boolean example: false error: type: string description: Human-readable error message example: Invalid request body data: type: 'null' example: null authType: type: string enum: - api_key - session example: api_key Founder: type: object description: Information about a company founder or team member properties: name: type: string description: Full name example: Jane Smith email: type: string format: email nullable: true description: Email address example: jane@example.com phone: type: string nullable: true description: Phone number example: +1-555-123-4567 title: type: string nullable: true description: Job title/role example: CEO/Co-Founder background: type: string nullable: true description: Professional background summary example: Former engineer at Google, 10 years in enterprise software linkedin_profile: type: string format: uri nullable: true description: LinkedIn profile URL example: https://www.linkedin.com/in/example/ UserPreference: type: object description: | Custom field for tracking company data. Supports multiple field types: - `text`: Free-form text input - `boolean`: True/false toggle - `select`: Single selection from predefined options required: - type - field properties: type: type: string enum: - text - boolean - select description: Field type example: select field: type: string description: Field name/label example: Industry value: oneOf: - type: string - type: boolean - type: 'null' description: Current value (type depends on field type) example: AI/ML options: type: array items: type: string description: Available options (for select fields) example: - SaaS - Fintech - AI/ML - Developer Tools show_in_table: type: boolean description: Whether this field is displayed in the companies table view default: false example: true CompanyStatus: type: object description: Deal flow pipeline status properties: id: type: string format: uuid status_text: type: string description: Display name of the status example: Initial Review color: type: string description: Hex color code example: '#3B82F6' rank: type: integer description: Order in pipeline (lower = earlier) Assignee: type: object description: Team member assigned to a company properties: id: type: string format: uuid description: User ID of the assignee name: type: string nullable: true description: Display name email: type: string format: email nullable: true description: Email address picture_url: type: string format: uri nullable: true description: Profile picture URL responses: BadRequestError: description: Bad request - invalid parameters or request body content: application/json: schema: $ref: '#/components/schemas/Error' example: success: false error: Invalid request body data: null UnauthorizedError: description: Unauthorized - missing or invalid API key content: application/json: schema: $ref: '#/components/schemas/Error' example: success: false error: Invalid or expired API key data: null NotFoundError: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/Error' example: success: false error: Resource not found data: null InternalServerError: description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error' example: success: false error: Internal server error data: null securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API Key description: | API key authentication. Generate keys from your account settings. Include in header: `Authorization: Bearer YOUR_API_KEY` ````