Create web link

post/v1/web-links

Create a web or social media link and associate it with people, companies, or workspaces.

Requires a bearer token: Authorization: Bearer <token>.

Request

cURL
curl -X POST https://api.wellapp.ai/v1/web-links \
  -H "Authorization: Bearer $WELL_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "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"
        }
      ]
    }
  }
}'
Request body
{
  "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"
        }
      ]
    }
  }
}

Responses

201 — Web link created successfully

{
  "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"
        }
      ]
    }
  }
}

400 — Bad request - invalid data

{
  "code": "BAD_REQUEST",
  "status": 400,
  "title": "Bad Request",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}

401 — Unauthorized - invalid API key

{
  "code": "UNAUTHORIZED",
  "status": 401,
  "title": "Unauthorized",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}

404 — Company not found