> ## Documentation Index > Fetch the complete documentation index at: https://docs.wellapp.ai/llms.txt > Use this file to discover all available pages before exploring further. # Create web link > Create a web or social media link and associate it with people, companies, or workspaces. ## OpenAPI ````yaml POST /v1/web-links openapi: 3.1.0 info: title: Well Document API version: 1.0.0 description: API for uploading and managing financial documents in the Well platform servers: - url: https://api.wellapp.ai security: [] paths: /v1/web-links: post: summary: Create web-link description: >- Create a web or social media link and associate it with people, companies, or workspaces. parameters: - $ref: '#/components/parameters/AuthorizationHeader' requestBody: required: true content: application/json: example: type: web_link attributes: platform: linkedin url: https://linkedin.com/in/ada relationships: persons: data: - type: people id: people1 companies: data: - type: company id: company_tenant workspaces: data: - type: workspace id: workspace_tenant schema: $ref: '#/components/schemas/WebLinkCreateRequest' responses: '201': description: Web link created successfully content: application/json: example: type: social_link id: sl1 attributes: platform: linkedin url: https://linkedin.com/in/ada created_at: '2025-06-01T10:00:00Z' updated_at: '2025-06-01T10:00:00Z' relationships: persons: data: - type: people id: people1 companies: data: - type: company id: company_tenant workspaces: data: - type: workspace id: workspace_tenant schema: $ref: '#/components/schemas/WebLinkCreateResponse' '400': description: Bad request - invalid data '401': description: Unauthorized - invalid API key content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '404': $ref: '#/components/responses/CompanyNotFound' components: parameters: AuthorizationHeader: name: Authorization in: header required: true schema: type: string description: Bearer token for authentication schemas: WebLinkCreateRequest: type: object properties: data: type: object properties: type: type: string const: web_link attributes: $ref: '#/components/schemas/WebLinkCreateAttributes' relationships: $ref: '#/components/schemas/SimpleRelationships' required: - type - attributes required: - data WebLinkCreateResponse: type: object properties: data: type: object properties: type: type: string example: web_link id: type: string format: uuid attributes: $ref: '#/components/schemas/WebLinkAttributes' relationships: type: object properties: persons: $ref: '#/components/schemas/PersonRelationship' companies: $ref: '#/components/schemas/CompanyRelationship' workspaces: $ref: '#/components/schemas/WorkspaceRelationship' UnauthorizedError: type: object properties: code: type: string example: UNAUTHORIZED description: Error code identifier status: type: integer example: 401 description: HTTP status code title: type: string example: Unauthorized description: Error title message: type: string example: You are not authorized to access this resource description: Detailed error message meta: type: object properties: log_id: type: string format: uuid example: 65c669d4-679c-4a8b-b8c0-fbe37699bb5b description: Unique identifier for tracking this error in logs required: - log_id required: - code - status - title - message - meta WebLinkCreateAttributes: type: object properties: platform: type: string enum: - website - linkedin - x - github description: Web platform type url: type: string minLength: 1 maxLength: 500 description: Full profile URL required: - url SimpleRelationships: type: object properties: persons: $ref: '#/components/schemas/PersonRelationRequest' companies: $ref: '#/components/schemas/CompanyRelationRequest' workspaces: $ref: '#/components/schemas/WorkspaceRelationRequest' WebLinkAttributes: type: object properties: platform: type: string enum: - website - linkedin - x - github description: Web platform type url: type: string description: Full profile URL created_at: type: string format: date-time description: Date and time when the web link was created updated_at: type: string format: date-time description: Date and time when the web link was updated PersonRelationship: type: object properties: data: type: array items: $ref: '#/components/schemas/PersonRelationshipItem' CompanyRelationship: type: object properties: data: type: array items: $ref: '#/components/schemas/CompanyRelationshipItem' WorkspaceRelationship: type: object properties: data: type: array items: $ref: '#/components/schemas/WorkspaceRelationshipItem' PersonRelationRequest: type: object properties: data: type: array items: type: object properties: type: type: string enum: - people id: type: string description: >- UUID of an existing people or temp-id that references an people defined in the included array required: - type - id CompanyRelationRequest: type: object properties: data: type: array items: type: object properties: type: type: string enum: - company id: type: string description: >- UUID of an existing companies or temp-id that references an companies defined in the included array required: - type - id WorkspaceRelationRequest: type: object properties: data: type: array items: oneOf: - properties: type: type: string enum: - workspace external_workspace_id: type: string description: External workspace identifier required: - type - external_workspace_id - properties: type: type: string enum: - workspace id: type: string format: uuid description: >- UUID of an existing workspace or temp-id that references an workspace defined in the included array required: - type - id PersonRelationshipItem: type: object properties: type: type: string enum: - people id: type: string description: Person ID attributes: $ref: '#/components/schemas/PersonAttributes' CompanyRelationshipItem: type: object properties: type: type: string enum: - company id: type: string description: Company ID attributes: $ref: '#/components/schemas/CompanyAttributes' WorkspaceRelationshipItem: type: object properties: type: type: string enum: - workspace id: type: string description: Workspace ID attributes: $ref: '#/components/schemas/WorkspaceAttributes' PersonAttributes: type: object description: Person attribute data properties: first_name: type: string description: Person's first name example: Marie minLength: 1 maxLength: 100 last_name: type: string description: Person's last name example: Dubois minLength: 1 maxLength: 100 full_name: type: string description: Auto-computed full name (first + last) example: Marie Dubois readOnly: true created_at: type: string format: date-time description: Person creation timestamp (UTC) example: '2024-01-15T10:30:00Z' readOnly: true updated_at: type: - string - 'null' format: date-time description: Last modification timestamp (UTC) example: '2024-01-16T14:20:00Z' readOnly: true required: - first_name - last_name - created_at CompanyAttributes: type: object properties: description: type: string domain_name_primary_link_url: type: string format: url maxLength: 500 description: >- The domain url from the website or email address of the company. Used as unique identifier in some cases. examples: - acme.com tax_id: type: object properties: value: description: Tax ID issued by local or national tax authority. type: string examples: - DE123456789 type: description: >- Type of tax ID, useful for applying formatting and validation rules. type: string examples: - VAT registration: type: object properties: trade_name: description: Commercial or branding name (if different from registered name). type: string examples: - TechSol registered_name: description: Legal company name. type: string minLength: 1 maxLength: 100 examples: - Red Hat Inc. registration_number: type: object properties: business_type: description: Legal entity structure type. type: string examples: - GmbH value: description: Official company registration number. type: string examples: - HRB 123456 registry_name: description: Name of the official registration body. type: string examples: - Handelsregister Berlin registry_country: description: Country of the registry authority. (string (ISO 3166-1 alpha-2)) type: string examples: - DE workspace_id: type: string format: uuid description: UUID of the workspace associated with this company created_at: type: string format: date-time updated_at: type: string format: date-time WorkspaceAttributes: type: object properties: name: type: string description: Workspace name desription: type: string description: Workspace description external_workspace_id: type: string format: uuid description: external workspace id avatar_color: type: string format: colors description: Color of the avatar created_at: type: string format: date-time description: Timestamp when the workspace was created updated_at: type: string format: date-time description: Timestamp when the workspace was last updated responses: CompanyNotFound: description: Company not found content: application/json: schema: type: object properties: code: type: string example: COMPANY_NOT_FOUND description: Error code identifier status: type: integer example: 404 description: HTTP status code title: type: string example: Company Not Found description: Error title message: type: string example: The requested company could not be found description: Detailed error message meta: type: object properties: log_id: type: string format: uuid example: 65c669d4-679c-4a8b-b8c0-fbe37699bb5b description: Unique identifier for tracking this error in logs required: - log_id required: - code - status - title - message - meta ````